File tree Expand file tree Collapse file tree 1 file changed +19
-3
lines changed Expand file tree Collapse file tree 1 file changed +19
-3
lines changed Original file line number Diff line number Diff line change @@ -4,13 +4,24 @@ RP Tree is a command-line tool to generate a directory tree diagram.
4
4
5
5
## Run the App
6
6
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
8
10
9
11
``` sh
10
- $ python3 tree.py /path/to/directory/
12
+ $ cd rptree/
13
+ $ python -m venv ./venv
14
+ $ source venv/bin/activate
15
+ (venv) $
11
16
```
12
17
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.
14
25
15
26
## Current Features
16
27
@@ -23,6 +34,11 @@ RP Tree also provides the following options:
23
34
- ` -d ` , ` --dir-only ` generates a directory-only tree
24
35
- ` -o ` , ` --output-file ` generates a tree and save it to a file in markdown format
25
36
37
+ ## Release History
38
+
39
+ - 0.1.0
40
+ - A work in progress
41
+
26
42
## About the Author
27
43
28
44
Leodanis Pozo Ramos - Email: leodanis@realpython.com
You can’t perform that action at this time.
0 commit comments