Skip to content

Commit e987cf2

Browse files
committed
updated README with additional setup instructions for windows
1 parent d2e4f32 commit e987cf2

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,30 @@ $ npm start
8888
| <b>[Node js](https://nodejs.org/en/)</b> | <b>Tested on v12.0+ |
8989
|--|--|
9090
| <b>[Git](https://git-scm.com/)</b> | <b>Tested on v2.20+</b> |
91+
92+
> **Important note for windows users**
93+
94+
If you are a windows user, then make sure that `git` is accessible from the command line without using git bash.
95+
96+
- Open command prompt or powershell and enter `git --version` and press enter. If it displays the following output, then it is fine
97+
98+
```
99+
C:\> git --version
100+
101+
git version 2.28.0.windows.1
102+
```
103+
104+
If this output is not displayed and if the command throws the following error, then it shows that `git` is not added to the 'path' environment variable and it will not be accessible directly from the command line,
105+
106+
```
107+
C:\> git --version
108+
109+
'git' is not recognized as an internal or external command,
110+
operable program or batch file.
111+
```
112+
113+
This can be fixed by adding `git` to the PATH environment variable in windows. The process of setting this up is available [here](https://stackoverflow.com/questions/26620312/git-installing-git-in-path-with-github-client-for-windows#answer-53706956:~:text=comment-,27,Here%20is%20the%20magic)
114+
91115

92116
# Detailed documentation
93117

@@ -97,3 +121,4 @@ Refer the detailed [Documentation](DOCUMENTATION.md) for how to setup and use th
97121

98122
See [LICENSE ](LICENSE) info for more
99123

124+

0 commit comments

Comments
 (0)