mirror of
https://github.com/Gerald-Ha/GGTree.git
synced 2025-04-28 04:32:55 +00:00
Update README.md
This commit is contained in:
parent
3a942324e2
commit
a2e1ea0cf8
24
README.md
24
README.md
@ -17,7 +17,6 @@ Directory tree for: /python/tree
|
|||||||
[14:22:07] User: /python/tree$
|
[14:22:07] User: /python/tree$
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- Lists all files and directories in a clear tree structure.
|
- Lists all files and directories in a clear tree structure.
|
||||||
- Works from the current directory.
|
- Works from the current directory.
|
||||||
@ -29,13 +28,34 @@ Directory tree for: /python/tree
|
|||||||
## Installation
|
## Installation
|
||||||
1. Download the files `GGTree.py`, `install.sh`, and `uninstall.sh`.
|
1. Download the files `GGTree.py`, `install.sh`, and `uninstall.sh`.
|
||||||
2. Navigate to the directory where these files are located.
|
2. Navigate to the directory where these files are located.
|
||||||
3. Run the installation script:
|
3. Ensure the installation script has the correct permissions. If not, run the following command:
|
||||||
|
```bash
|
||||||
|
chmod +x install.sh uninstall.sh
|
||||||
|
```
|
||||||
|
4. Run the installation script:
|
||||||
```bash
|
```bash
|
||||||
sudo ./install.sh
|
sudo ./install.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
After installation, you can execute the program using the command `ggtree` from anywhere in the terminal.
|
After installation, you can execute the program using the command `ggtree` from anywhere in the terminal.
|
||||||
|
|
||||||
|
### Optional: Use a Virtual Environment
|
||||||
|
To avoid conflicts with system-wide Python packages, consider running the program inside a virtual environment:
|
||||||
|
1. Create a virtual environment:
|
||||||
|
```bash
|
||||||
|
python3 -m venv ggtree_env
|
||||||
|
```
|
||||||
|
2. Activate the virtual environment:
|
||||||
|
- On Linux/macOS:
|
||||||
|
```bash
|
||||||
|
source ggtree_env/bin/activate
|
||||||
|
```
|
||||||
|
- On Windows:
|
||||||
|
```bash
|
||||||
|
ggtree_env\Scripts\activate
|
||||||
|
```
|
||||||
|
3. Install any dependencies (if required) within the virtual environment.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
Simply run the following command in the terminal:
|
Simply run the following command in the terminal:
|
||||||
```bash
|
```bash
|
||||||
|
Loading…
Reference in New Issue
Block a user