Skip to content

Commit 3a962f9

Browse files
committed
README.md updated
1 parent 933207f commit 3a962f9

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

Directory Tree Visualizer/README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,47 @@
22

33
dirtree.py is a Python utility toolkit designed for effective directory navigation and visualization. It offers various functions to suit different visualization needs, allowing users to explore and understand project hierarchies. Whether you need a simple tree view or a beautified structure, dirtree.py has you covered.
44

5+
## Quick Visualization with Beautify Tree Structure
6+
7+
This section allows users to quickly visualize their directory structure using the beautify tree structure feature of `dirtree.py`. The example command and output illustrate how effortlessly you can beautify and understand the hierarchy of your project.
8+
9+
```bash
10+
python dirtree.py beautify /path/to/my-nodejs-app
11+
```
12+
13+
**Example Output:**
14+
15+
```bash
16+
- my-nodejs-app
17+
|- config
18+
| |- appConfig.js
19+
| |- database.js
20+
|- controllers
21+
| |- database.js
22+
| |- postController.js
23+
|- middlewares
24+
| |- authentication.js
25+
| |- authorization.js
26+
|- models
27+
| |- post.js
28+
| |- user.js
29+
|- package.json
30+
|- public
31+
| |- images
32+
| |- styles
33+
|- routes
34+
| |- api
35+
| | |- posts.js
36+
| | |- users.js
37+
| |- index.js
38+
| |- web
39+
| | |- auth.js
40+
| | |- home.js
41+
|- server.js
42+
|- services
43+
|- utils
44+
```
45+
546
## Main Features
647

748
- **Simple Tree:** Display a simple tree view of the directory.
@@ -171,5 +212,5 @@ python dirtree.py beautify /path/to/directory
171212
### Notes
172213

173214
- Adjust the `/path/to/directory` to the actual path you want to visualize.
174-
- Use the `--path_style` option to specify the path style for formatting (auto, /, \).
215+
- Use the `--path_style` option to specify the path style for formatting ("auto", "/", "\").
175216
- Choose the desired function based on your visualization requirements.

0 commit comments

Comments
 (0)