Skip to content

Commit b76f56f

Browse files
authored
add specific installation instructions and troubleshooting FAQ to README (sukeesh#1072)
1 parent cc642f5 commit b76f56f

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,29 @@ A Personal Assistant for Linux, MacOS and Windows
88

99
Jarvis is a simple personal assistant for Linux, MacOS and Windows which works on the command line. He can talk to you if you enable his voice. He can tell you the weather, he can find restaurants and other places near you. He can do some great stuff for you.
1010

11-
## Getting Started
11+
## Getting Started With Installation
1212

13-
In order to start Jarvis just clone [this repository](https://github.com/sukeesh/Jarvis.git) and run `python installer`.
13+
In order to install Jarvis, follow these steps:
14+
1. Clone [this repository](https://github.com/sukeesh/Jarvis.git) with `git clone https://github.com/sukeesh/Jarvis.git`
15+
2. Run the command `python installer` (or `python3 installer` if that doesn't work) from the terminal.
1416

15-
Run **Jarvis** from anywhere by command `jarvis`
17+
Run **Jarvis** from anywhere by command `jarvis`, or `./jarvis` from within the project directory to start up Jarvis!
1618

1719
You can start by typing `help` within the Jarvis command line to check what Jarvis can do for you.
1820

21+
### Frequently encountered issues
22+
**Question**: When I run Jarvis, it shows an error relating to module not found<br>
23+
**Platform**: Windows<br>
24+
**Solution 1**: Uninstall and/or install the module package<br>
25+
Example:<br>
26+
Error: `ImportError: DLL load failed while importing win32api: The specified module could not be found.`<br>
27+
Solution:<br>
28+
`pip uninstall pywin32`<br>
29+
`pip install pywin32` or `conda instapll pywin32`<br>
30+
**Solution 2**: add the package to your environment variables system PATH.<br>
31+
32+
33+
If you find other issues and/or have found solutions to them on any platform, please consider adding to this list!
1934

2035
## Youtube Video Showing Jarvis
2136

0 commit comments

Comments
 (0)