Merge pull request #1203 from leoscarlato/update-readme

Improving README readability

README.md

@@ -8,63 +8,138 @@ A Personal Non-AI Assistant for Linux, MacOS and Windows
 
 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.
 
-## 20 Different Tasks That Jarvis Can Do For You ("Plugin Name" Included)
-1. Suggest a random activity for you to do if you're bored ("activity", "bored")
-2. Give ideas for what to draw, watch, do, listen to (“prompt”, “top_media”, “taste dive”, “mood music”)
-3. Receive up-to-date information about different sports such as team ranking, match starts times, player stats ( “basketball” , “cricket”, “soccer”, “tennis”)
-4. Play games (“blackjack”, “connect_four”, “guess_number_game”, “hangman”, “rockpaperscissors”. “roulette”, “tic_tac_toe”,”word_game”, “wordle”)
-5. Help you stay fit by giving food nutrition facts, recipes, workout programs, and health trackers (“bmi”, “bmr”, “calories”, “food recipe”, “fruit”, “fruit nutrition”, “workout”)
-6. Teach you how to make a cocktail (“cocktail”, “drink”)
-7. Generate random lists, numbers, passwords (“random list”, “random number”, “random password”)
-8. Perform conversions for binary numbers, money, hexadecimal numbers, distance, mass, speed, strings, temp, time (“binary”, “currencyconv”, “hex”, “lengthconv”, “massconv”, “speedconv”, “string_convert”, “tempconv”, “timveconv”)
-9. Take pictures (“open camera”, “screencapture”)
-10. Tell you different specifications for your current computer system (“battery”,  “cat his”, “dns forward”, “dns reverse”, “hostinfo”, “ip”, “scan_network”, “speedtest”, “os”, “check ram”, “systeminfo”)
-11. Manage files on your computer (“file manage”, “file organize”
-12. Upload, edit, and convert images (“imgur”, “image to pdg”,  “image compressor”)
-13. Convert webpages to PDF or PDFs to images (“htmptopdg”, “pdf to images”)
-14. Tell jokes (“dadjoke”, “joke daily”, “joke chuck”, “joke”) 
-15. Perform arithmetic and calculations (“calculate”, “factor”, “solve”, “equations”, “plot”, “matrix add”)
-16. Generate a QR code to attach to a URL (“qr”)
-17. Check the weather (“weather report”)
-18. Provide language translations (“translate”)
-19. Tell random facts (“fact”, “cat fact”)
-20. Display stock market information (“stock”, “cryptotracker”)
-
-## Getting Started With Installation
-
-In order to install Jarvis, follow these steps:
-1. Clone [this repository](https://github.com/sukeesh/Jarvis.git) with `git clone https://github.com/sukeesh/Jarvis.git`
-2. Run the command `python installer` (or `python3 installer` if that doesn't work) from the terminal.
-
-Run **Jarvis** from anywhere by command `jarvis`, or `./jarvis` from within the project directory to start up Jarvis!
+## 🚀 20 Different Tasks That Jarvis Can Do For You:
+
+1. **Entertainment & Suggestions**
+   - Suggest activities if you're bored (`activity`, `bored`)
+   - Provide ideas on what to draw, watch, or listen to (`prompt`, `top_media`, `taste dive`, `mood music`)
+
+2. **Sports Updates**
+   - Get up-to-date sports information: team rankings, match times, player stats (`basketball`, `cricket`, `soccer`, `tennis`)
+
+3. **Games**
+   - Play games: Blackjack, Connect Four, Hangman, Rock-Paper-Scissors, etc. (`blackjack`, `connect_four`, `guess_number_game`, `hangman`, `rockpaperscissors`, `roulette`, `tic_tac_toe`, `word_game`, `wordle`)
+
+4. **Health & Fitness**
+   - Access nutrition facts, recipes, workout programs, and health trackers (`bmi`, `bmr`, `calories`, `food recipe`, `fruit`, `fruit nutrition`, `workout`)
+
+5. **Cocktail Recipes**
+   - Learn how to make cocktails (`cocktail`, `drink`)
+
+6. **Random Generators**
+   - Generate random lists, numbers, passwords (`random list`, `random number`, `random password`)
+
+7. **Unit Conversions**
+   - Convert units: binary, currency, hex, length, mass, speed, temperature, time (`binary`, `currencyconv`, `hex`, `lengthconv`, `massconv`, `speedconv`, `string_convert`, `tempconv`, `timeconv`)
+
+8. **Photography**
+   - Take pictures and screenshots (`open camera`, `screencapture`)
+
+9. **System Information**
+   - Get computer specifications (`battery`, `cat his`, `dns forward`, `dns reverse`, `hostinfo`, `ip`, `scan_network`, `speedtest`, `os`, `check ram`, `systeminfo`)
+
+10. **File Management**
+    - Manage and organize files (`file manage`, `file organize`)
+
+11. **Image Processing**
+    - Upload, edit, and convert images (`imgur`, `image to pdf`, `image compressor`)
+
+12. **PDF Conversion**
+    - Convert webpages to PDF or PDFs to images (`htmltopdf`, `pdf to images`)
+
+13. **Jokes & Facts**
+    - Enjoy jokes and random facts (`dadjoke`, `joke daily`, `joke chuck`, `joke`, `fact`, `cat fact`)
+
+14. **Calculations**
+    - Perform calculations and solve equations (`calculate`, `factor`, `solve`, `equations`, `plot`, `matrix add`)
+
+15. **QR Code Generation**
+    - Generate QR codes for URLs (`qr`)
+
+16. **Weather Updates**
+    - Check the weather forecast (`weather report`)
+
+17. **Language Translation**
+    - Translate languages (`translate`)
+
+18. **Stock Market Information**
+    - Display stock and cryptocurrency information (`stock`, `cryptotracker`)
+
+## 🛠️ Getting Started
+
+### Installation
+
+1. **Clone the Repository**
+
+   ```bash
+   git clone https://github.com/sukeesh/Jarvis.git
+   ```
+
+2. **Run the installer**
+   ```bash
+   python installer
+   ```
+   If that doesn't work, try:
+   ```bash
+   python3 installer
+   ```
+
+### Running Jarvis
+
+- Run Jarvis from anywhere:
+
+   ```bash
+   jarvis
+   ```
+
+  Or from within the project folder:
+
+   ```bash
+   ./jarvis
+   ```
 
 You can start by typing `help` within the Jarvis command line to check what Jarvis can do for you.
 
-### Frequently encountered issues
-**Question**: When I run Jarvis, it shows an error relating to module not found<br>
-**Platform**: Windows<br>
-**Solution 1**: Uninstall and/or install the module package<br>
-Example:<br>
+## ❓Frequently encountered issues
+**Question**: 
+When I run Jarvis, it shows an error relating to module not found<br>
+
+**Platform**: 
+Windows<br>
+
+**Solution 1**: Uninstall and/or install the module package.<br>
+
+**Example:**<br>
 Error: `ImportError: DLL load failed while importing win32api: The specified module could not be found.`<br>
-Solution:<br>
+
+**Solution:**<br>
 `pip uninstall pywin32`<br>
 `pip install pywin32` or `conda install pywin32`<br>
+
 **Solution 2**: add the package to your environment variables system PATH.<br>
 
-**Question**: After cloning the repo in terminal it gives an error when running python3 installer saying please install virtual environemnt
+-----
+
+**Question**: After cloning the repo in terminal it gives an error when running python3 installer saying please install virtual environemnt.
+
 **Solution**: 
-- Install virtual env using this command "python3 -m pip install virtualenv"
+- Install virtual env using this command:
+  ```bash
+  python3 -m pip install virtualenv
+  ```
 - OR: On Linux use package manager (e.g. Ubuntu sudo apt install python3-venv)
+
 - Restart Installer
 
+-----
 
-If you find other issues and/or have found solutions to them on any platform, please consider adding to this list!
+**If you find other issues and/or have found solutions to them on any platform, please consider adding to this list!**
 
-## Youtube Video Showing Jarvis
+## 💻 Youtube Video Showing Jarvis
 
 [Click here](https://www.youtube.com/watch?v=PR-nxqmG3V8)
 
-## Contributing
+## 🤝 Contributing
 
 Check out our [CONTRIBUTING.md](CONTRIBUTING.md) to learn how you can contribute!