Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b6b3c74

Browse files
committed
Update README.md
1 parent 2ca0c46 commit b6b3c74

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# dirtree
2-
Directory Tree Generator
1+
# RP Tree
2+
3+
RP Tree is a command-line tool to generate a directory tree diagram.
4+
5+
## Run the App
6+
7+
Create a Python virtual environment and run the application:
8+
9+
```sh
10+
$ python3 tree.py /path/to/directory/
11+
```
12+
13+
**Note:** The `-h` option provides help on how to use RP Tree.
14+
15+
## Current Features
16+
17+
If you run RP Tree with a directory path as an argument, then you get the full directory tree printed on your screen. The default input directory is your current directory.
18+
19+
RP Tree also provides the following options:
20+
21+
- `-v`, `--version` shows the application version and exits
22+
- `-h`, `--help` show a usage message
23+
- `-d`, `--dir-only` generates a directory-only tree
24+
- `-o`, `--output-file` generates a tree and save it to a file in markdown format
25+
26+
## About the Author
27+
28+
Leodanis Pozo Ramos - Email: [email protected]

0 commit comments

Comments
 (0)