Skip to content

Commit fbf8268

Browse files
docs: finally a good readme version. Thanks chris you project is very nice!
1 parent 8119d6b commit fbf8268

File tree

1 file changed

+38
-9
lines changed

1 file changed

+38
-9
lines changed

README.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
A fast, customizable command-line tool for generating tree-like representations of directory structures, with intelligent handling of .gitignore rules and cross-platform compatibility.
44

5+
- This project is a fork from [chrisw-org/tree-view-cli](https://github.com/chrisw-org/tree-view-cli.git)
6+
7+
58
## Features
69

710
- 🚀 **Fast execution**: Optimized Python implementation for quick directory processing
@@ -16,6 +19,14 @@ A fast, customizable command-line tool for generating tree-like representations
1619

1720
## Installation
1821

22+
### Automatic by Astral uv
23+
24+
```bash
25+
uv tool install "git+https://github.com/kaiosilva-dataeng/tree-view-cli.git@main"
26+
```
27+
28+
### Manual
29+
1930
```bash
2031
# Clone the repository
2132
git clone https://github.com/kaiosilva-dataeng/tree-view-cli.git
@@ -25,18 +36,26 @@ cd tree-view-cli
2536
uv sync
2637
```
2738

39+
### Troubleshooting Project Installation Issues
40+
41+
In case the project is not installed automatically, please refer to the following steps to resolve the issue:
42+
43+
```bash
44+
uv tool install .
45+
```
46+
2847
## Usage
2948

3049
Basic usage:
3150

3251
```bash
33-
python tree_view_cli.py /path/to/directory
52+
tree-view /path/to/directory
3453
```
3554

3655
Limiting directory depth:
3756

3857
```bash
39-
python tree_view_cli.py /path/to/directory --max-depth 2
58+
tree-view /path/to/directory --max-depth 2
4059
```
4160

4261
### Options
@@ -116,18 +135,28 @@ This project uses GitHub Actions for continuous integration. The workflow includ
116135

117136
```
118137
tree-view-cli/
119-
├── tests/
138+
├── .github
139+
│ └── workflows
140+
│ └── ci.yml # GitHub Actions CI workflow
141+
├── .vscode # VS Code configuration
142+
├── src
143+
│ └── tree_view_cli
144+
│ └── tree_view_cli.py # Main application module
145+
├── tests
120146
│ ├── conftest.py # Test fixtures and setup
121147
│ └── test_tree_view_cli.py # Test suite
122-
├── .github/
123-
│ └── workflows/ # CI configuration
124-
├── .vscode/ # VS Code configuration
125-
├── Dockerfile # Docker configuration
148+
├── .dockerignore # Files to exclude from Docker context
149+
├── .gitignore # Files to exclude from git
150+
├── .pre-commit-config.yaml # Pre-commit hooks configuration
151+
├── .python-version # Python version specification
126152
├── compose.yaml # Docker Compose configuration
127-
├── tree_view_cli.py # Main application module
153+
├── Dockerfile # Docker configuration
154+
├── LICENSE # Project license
155+
├── Makefile # Make commands for Docker
128156
├── pyproject.toml # Project metadata and dependencies
157+
├── README.Docker.md # Docker-specific documentation
129158
├── README.md # Project documentation
130-
└── README.Docker.md # Docker-specific documentation
159+
└── uv.lock # Dependency lock file
131160
```
132161

133162
## Contributing

0 commit comments

Comments
 (0)