From c74a829ae4320d68940457271c909fc4c586d1e4 Mon Sep 17 00:00:00 2001 From: Prathap <436prathap@gmail.com> Date: Fri, 26 Mar 2021 22:52:17 +0530 Subject: [PATCH 1/3] update readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 1e23b70c..ad808d58 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,10 @@ If you find this interesting, come and discuss on [`#hydrogen:matrix.org`](https Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You can run it locally `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`. If you prefer, you can also [use docker](doc/docker.md). +## For Windows Users + +For security reasons, it is better to invoke the command prompt as administrator before running `yarn install`. It is due to the different behavior of [symlinks in windows](https://github.com/git-for-windows/git/wiki/Symbolic-Links). + # FAQ Some frequently asked questions are answered [here](doc/FAQ.md). From 3bc21c75d8aa67df079c4ecb686be0e3605f80f6 Mon Sep 17 00:00:00 2001 From: Prathap-P <66202489+Prathap-P@users.noreply.github.com> Date: Wed, 28 Apr 2021 15:53:37 +0530 Subject: [PATCH 2/3] Update README.md Co-authored-by: Bruno Windels --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ad808d58..2fb50b10 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,7 @@ If you find this interesting, come and discuss on [`#hydrogen:matrix.org`](https Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You can run it locally `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`. If you prefer, you can also [use docker](doc/docker.md). +Hydrogen uses symbolic links in the codebase, so if you are on Windows, have a look at [making git & symlinks work](https://github.com/git-for-windows/git/wiki/Symbolic-Links) there. ## For Windows Users For security reasons, it is better to invoke the command prompt as administrator before running `yarn install`. It is due to the different behavior of [symlinks in windows](https://github.com/git-for-windows/git/wiki/Symbolic-Links). From 57b6c45e347ada954f5fc75be0da6f217f6b8f66 Mon Sep 17 00:00:00 2001 From: Prathap-P <66202489+Prathap-P@users.noreply.github.com> Date: Fri, 30 Apr 2021 13:40:10 +0530 Subject: [PATCH 3/3] Ensured more subtleness in the readme file. --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 2fb50b10..6ee25ae6 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,6 @@ If you find this interesting, come and discuss on [`#hydrogen:matrix.org`](https Hydrogen is deployed to [hydrogen.element.io](https://hydrogen.element.io). You can run it locally `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`. If you prefer, you can also [use docker](doc/docker.md). Hydrogen uses symbolic links in the codebase, so if you are on Windows, have a look at [making git & symlinks work](https://github.com/git-for-windows/git/wiki/Symbolic-Links) there. -## For Windows Users - -For security reasons, it is better to invoke the command prompt as administrator before running `yarn install`. It is due to the different behavior of [symlinks in windows](https://github.com/git-for-windows/git/wiki/Symbolic-Links). # FAQ