You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-15Lines changed: 31 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -1,38 +1,54 @@
1
1
# RP Tree
2
2
3
-
RP Tree is a command-line tool to generate a directory tree diagram.
3
+
RP Tree is a command-line tool to generate directory tree diagrams.
4
4
5
-
## Run the App
5
+
## Installation
6
6
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
7
+
To install **RP Tree**, just run the following command:
10
8
11
9
```sh
12
-
$ cd rptree/
13
-
$ python -m venv ./venv
14
-
$ source venv/bin/activate
15
-
(venv) $
10
+
$ pip install rptree
16
11
```
17
12
18
-
2. Run the application
13
+
## Usage
19
14
20
15
```sh
21
-
(venv) $ python tree.py /path/to/directory/
16
+
$ rptree /path/to/directory/
22
17
```
23
18
24
19
**Note:** The `-h` or `--help` option provides help on how to use RP Tree.
25
20
26
-
## Current Features
21
+
## Sample Output
22
+
23
+
```sh
24
+
$ rptree hello/
25
+
./hello/
26
+
│
27
+
├── hello/
28
+
│ ├── __init__.py
29
+
│ └── hello.py
30
+
│
31
+
├── tests/
32
+
│ └── test_hello.py
33
+
│
34
+
├── requirements.txt
35
+
├── setup.py
36
+
├── README.md
37
+
└── LICENSE
38
+
```
39
+
40
+
That's it! You've generated a nice directory tree diagram.
41
+
42
+
## Features
27
43
28
-
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.
44
+
If you run RP Tree with a directory path as an argument, then you get a full directory tree diagram printed on your screen. The default input directory is your current directory.
29
45
30
46
RP Tree also provides the following options:
31
47
32
48
-`-v`, `--version` shows the application version and exits
33
49
-`-h`, `--help` show a usage message
34
-
-`-d`, `--dir-only` generates a directory-only tree
35
-
-`-o`, `--output-file` generates a tree and save it to a file in markdown format
50
+
-`-d`, `--dir-only` generates a directory-only tree diagram
51
+
-`-o`, `--output-file` generates a full directory tree diagram and save it to a file in markdown format
0 commit comments