10000 Update README.md · realpython/rptree@70ae0c0 · GitHub
[go: up one dir, main page]

Skip to content

Commit 70ae0c0

Browse files
committed
Update README.md
1 parent 3d4f573 commit 70ae0c0

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,24 @@ RP Tree is a command-line tool to generate a directory tree diagram.
44

55
## Run the App
66

7-
Create a Python virtual environment and run the application:
7+
To run **RP Tree**, you need to download the source code. Then open a terminal or command-line window and run the following steps:
8+
9+
1. Create and activate a Python virtual environment
810

911
```sh
10-
$ python3 tree.py /path/to/directory/
12+
$ cd rptree/
13+
$ python -m venv ./venv
14+
$ source venv/bin/activate
15+
(venv) $
1116
```
1217

13-
**Note:** The `-h` option provides help on how to use RP Tree.
18+
2. Run the application
19+
20+
```sh
21+
(venv) $ python tree.py /path/to/directory/
22+
```
23+
24+
**Note:** The `-h` or `--help` option provides help on how to use RP Tree.
1425

1526
## Current Features
1627

@@ -23,6 +34,11 @@ RP Tree also provides the following options:
2334
- `-d`, `--dir-only` generates a directory-only tree
2435
- `-o`, `--output-file` generates a tree and save it to a file in markdown format
2536

37+
## Release History
38+
39+
- 0.1.0
40+
- A work in progress
41+
2642
## About the Author
2743

2844
Leodanis Pozo Ramos - Email: leodanis@realpython.com

0 commit comments

Comments
 (0)
0