updated readme to work with nre name
Gitea Actions For Tree-Structurer / Explore-Gitea-Actions (push) Successful in 20s Details

This commit is contained in:
Falko Victor Habel 2025-01-30 11:39:04 +01:00
parent 380b3aacb2
commit 763083a5cc
1 changed files with 12 additions and 6 deletions

View File

@ -1,4 +1,4 @@
# Tree-Structurer
# prodir
This is a Python package designed to display directory structures in a tree-like format. This tool provides an easy-to-read overview of the directory hierarchy, making it easier for developers to navigate complex project structures.
@ -7,7 +7,7 @@ This is a Python package designed to display directory structures in a tree-like
To install `tree_structurer`, you can use pip:
```bash
pip install git+https://gitea.fabelous.app/Fabel/Tree-Structurer.git
pip install git+https://gitea.fabelous.app/Fabel/prodir.git
```
@ -18,13 +18,19 @@ You can run `tree_structurer` from the command line. By default, it will analyze
To display the directory structure of the current directory:
```bash
python -m tree_structurer
python -m prodir
```
or
```bash
prodir
```
To display the directory structure of a specific directory:
```bash
python -m tree_structurer /path/to/directory
python -m prodir /path/to/directory
```
#### Options
@ -34,12 +40,12 @@ python -m tree_structurer /path/to/directory
Example:
```bash
python -m tree_structurer /path/to/directory -v
python -m prodir /path/to/directory -v
```
#### Important Files and Folders Ignored
By default, `tree_structurer` ignores files and folders that start with `_` or `.`. However, it does include the following exceptions:
By default, `prodir` ignores files and folders that start with `_` or `.`. However, it does include the following exceptions:
- `__init__.py` and `__main__.py` files: These are considered important and will be included in the output.
- Special folders like `build`, `.git`, `node_modules`, etc.: These are also ignored to keep the output focused on the essential parts of the directory structure.