Skip to content

Commit 4e777cf

Browse files
Update README.md
1 parent 01b62d4 commit 4e777cf

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Whether you need to perform calculations, manage expenses, generate secure passw
1313
- **Unit Conversion**: Convert between various units of measurement seamlessly.
1414
- **YouTube Downloader**: Download your favorite videos from YouTube with simple commands.
1515

16-
## zap-cli Installation Guide
16+
17+
# zap-cli Installation Guide
1718
To get started with `zap-cli`, follow these steps:
1819

1920
### 1. Clone the Repository
@@ -28,24 +29,32 @@ cd zap-cli
2829
```
2930

3031
### 3. Make the Setup Script Executable
31-
Before running the setup script, make sure it's executable:
3232
```bash
3333
chmod +x scripting_tools/setup.sh
3434
```
3535

3636
### 4. Run the Setup Script
37-
Run the setup script to automatically configure the environment:
3837
```bash
3938
bash scripting_tools/setup.sh
4039
```
4140

4241
### The script will:
43-
* Install the required dependencies (Python, Zsh, virtual environment tools).
42+
* Install the required dependencies (Python, virtual environment tools).
4443
* Create and activate a Python virtual environment.
4544
* Install the dependencies listed in requirements.txt.
4645
* Set up zap-cli.py as a global command.
47-
* Set Zsh as the default shell and configure it for the virtual environment.
4846

49-
### Note:
50-
* Make sure bash is installed on your system to run the script.
51-
* The script will automatically create a virtual environment in the project folder and install all dependencies listed in requirements.txt.
47+
### 5. After Installation
48+
Once the script has completed, you can use zap-cli anywhere on your Ubuntu terminal.
49+
To verify that zap-cli is working, simply type:
50+
```bash
51+
zap-cli --help
52+
```
53+
54+
### Notes:
55+
* Ensure that bash is installed on your system to run the setup script.
56+
* The setup script will create a virtual environment in the project folder and install all dependencies listed in requirements.txt.
57+
58+
59+
60+

0 commit comments

Comments
 (0)