Skip to content

Commit fbbada7

Browse files
committed
Add license badges to README
1 parent 8258957 commit fbbada7

1 file changed

Lines changed: 74 additions & 0 deletions

File tree

README.adoc

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
= 🌲 Tree Navigator
22

3+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
4+
35
> A powerful, type-safe directory tree export and navigation tool written in Ada 2022
46

57
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
@@ -59,13 +61,19 @@ Tree Navigator automatically categorizes files:
5961
=== Installation
6062
```bash
6163
= Clone the repository
64+
65+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
6266
git clone https://github.com/yourusername/tree-navigator.git
6367
cd tree-navigator
6468

6569
= Build
70+
71+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
6672
gprbuild -P tree_navigator.gpr
6773

6874
= Optionally install system-wide
75+
76+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
6977
sudo cp bin/main /usr/local/bin/tree-navigator
7078
```
7179

@@ -76,15 +84,23 @@ sudo cp bin/main /usr/local/bin/tree-navigator
7684
Export directory trees to files with powerful filtering:
7785
```bash
7886
= Basic export
87+
88+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
7989
tree-navigator --export output.txt
8090

8191
= Export with depth limit
92+
93+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
8294
tree-navigator --export output.txt --max-depth 5
8395

8496
= Export specific directory
97+
98+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
8599
tree-navigator --export output.txt --dir /path/to/project
86100

87101
= Show file sizes
102+
103+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
88104
tree-navigator --export output.txt --show-size
89105
```
90106

@@ -94,59 +110,89 @@ tree-navigator --export output.txt --show-size
94110
Perfect for ignoring build artifacts and dependencies:
95111
```bash
96112
= Rust project - exclude build directory
113+
114+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
97115
tree-navigator --export rust-tree.txt --exclude-dirs target
98116

99117
= Node.js - exclude dependencies
118+
119+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
100120
tree-navigator --export node-tree.txt --exclude-dirs node_modules
101121

102122
= Multiple exclusions
123+
124+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
103125
tree-navigator --export clean-tree.txt --exclude-dirs "target,node_modules,.git,build,dist"
104126

105127
= Ada/GNAT project
128+
129+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
106130
tree-navigator --export ada-tree.txt --exclude-dirs obj,bin
107131
```
108132

109133
==== Exclude Files
110134
Filter out specific files or patterns:
111135
```bash
112136
= Exclude compiled objects
137+
138+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
113139
tree-navigator --export source-tree.txt --exclude-files "*.o,*.ali,*.so"
114140

115141
= Exclude temporary files
142+
143+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
116144
tree-navigator --export clean-tree.txt --exclude-files "*.tmp,*.log,*.bak,*~"
117145

118146
= Exclude multiple patterns
147+
148+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
119149
tree-navigator --export code-tree.txt --exclude-files "*.o,*.exe,*.dll,*.pyc"
120150
```
121151

122152
==== Filter by File Type
123153
Show only specific categories of files:
124154
```bash
125155
= Only executables
156+
157+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
126158
tree-navigator --export bins.txt --only-type executable
127159

128160
= Only configuration files
161+
162+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
129163
tree-navigator --export configs.txt --only-type config
130164

131165
= Only shell scripts
166+
167+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
132168
tree-navigator --export scripts.txt --only-type script
133169

134170
= Only data files (JSON, XML, YAML)
171+
172+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
135173
tree-navigator --export data.txt --only-type data
136174

137175
= Only directories (no files)
176+
177+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
138178
tree-navigator --export dirs.txt --no-files
139179

140180
= Only files (no subdirectories)
181+
182+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
141183
tree-navigator --export files.txt --no-dirs
142184
```
143185

144186
==== Hidden Files
145187
```bash
146188
= Include hidden files
189+
190+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
147191
tree-navigator --export full-tree.txt --show-hidden
148192

149193
= Show only hidden files
194+
195+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
150196
tree-navigator --export hidden-tree.txt --only-type hidden
151197
```
152198

@@ -155,6 +201,8 @@ tree-navigator --export hidden-tree.txt --only-type hidden
155201
==== Rust Project Documentation
156202
```bash
157203
= Clean tree for README, excluding build artifacts
204+
205+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
158206
tree-navigator --export project-structure.txt \
159207
--exclude-dirs "target,.git" \
160208
--exclude-files "*.lock,*.toml" \
@@ -164,6 +212,8 @@ tree-navigator --export project-structure.txt \
164212
==== Node.js Project
165213
```bash
166214
= Show project structure without dependencies
215+
216+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
167217
tree-navigator --export app-structure.txt \
168218
--exclude-dirs "node_modules,dist,.next,coverage" \
169219
--exclude-files "*.map,*.log" \
@@ -173,6 +223,8 @@ tree-navigator --export app-structure.txt \
173223
==== Find All Executables
174224
```bash
175225
= Locate all binary files in a project
226+
227+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
176228
tree-navigator --export executables.txt \
177229
--only-type executable \
178230
--show-size
@@ -181,6 +233,8 @@ tree-navigator --export executables.txt \
181233
==== Configuration Audit
182234
```bash
183235
= List all config files for review
236+
237+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
184238
tree-navigator --export all-configs.txt \
185239
--only-type config \
186240
--show-hidden
@@ -189,6 +243,8 @@ tree-navigator --export all-configs.txt \
189243
==== Shell Script Inventory
190244
```bash
191245
= Find all shell scripts in the system
246+
247+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
192248
tree-navigator --export scripts.txt \
193249
--dir /usr/local/bin \
194250
--only-type script
@@ -199,12 +255,18 @@ tree-navigator --export scripts.txt \
199255
Navigate directories interactively with depth control:
200256
```bash
201257
= Start interactive mode
258+
259+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
202260
tree-navigator
203261

204262
= Start with depth limit
263+
264+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
205265
tree-navigator 5
206266

207267
= Or
268+
269+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
208270
tree-navigator --depth 10
209271
```
210272

@@ -306,26 +368,38 @@ tree-navigator/
306368
=== Building from Source
307369
```bash
308370
= Clean build
371+
372+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
309373
gprclean -P tree_navigator.gpr
310374
gprbuild -P tree_navigator.gpr
311375

312376
= Using Make
377+
378+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
313379
make clean
314380
make build
315381

316382
= Run
383+
384+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
317385
./bin/main --help
318386
```
319387

320388
=== Running Tests
321389
```bash
322390
= Test basic export
391+
392+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
323393
./bin/main --export test.txt --max-depth 3
324394

325395
= Test with filters
396+
397+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
326398
./bin/main --export test.txt --exclude-dirs "obj,bin"
327399

328400
= Test file type filtering
401+
402+
image:https://img.shields.io/badge/license-AGPL--3.0-blue.svg[AGPL-3.0,link="https://www.gnu.org/licenses/agpl-3.0"] image:https://img.shields.io/badge/philosophy-Palimpsest-purple.svg[Palimpsest,link="https://github.com/hyperpolymath/palimpsest-licence"]
329403
./bin/main --export test.txt --only-type executable
330404
```
331405

0 commit comments

Comments
 (0)