@@ -22,7 +22,11 @@ A lightweight Python utility to quickly clone, configure, and build CMake projec
2222
2323<br />
2424
25-
25+ ## Quick start
26+ ``` bash
27+ pip install starlet-setup
28+ starlet-setup username/repo
29+ ```
2630
2731## Features
2832- ** Single Repository Mode** :
@@ -71,7 +75,8 @@ pip install git+https://github.com/masonlet/starlet-setup.git
7175
7276Once installed, you can use the ` starlet-setup ` command from anywhere.
7377
74- ### ⚠️ Command not found? ⚠️
78+ <details >
79+ <summary ><h4 >⚠️ Command not found? ⚠️</h4 ></summary >
7580If you get an error saying the command is not found, you may need to add Python's user scripts directory to your PATH:
7681
7782** Find your scripts directory** :
@@ -101,7 +106,7 @@ Alternatively, you can run the script directly:
101106``` bash
102107python -m starlet_setup username/repo
103108```
104-
109+ </ details >
105110
106111
107112<br />
@@ -131,9 +136,11 @@ Starlet Setup checks for configuration files in this order:
131136
132137## Usage
133138
134- ### Single Repository Mode
135-
139+ <details >
140+ <summary ><h3 >Single Repository Mode</h3 ></summary >
141+
136142#### Basic Usage
143+
137144``` bash
138145# Clone and build a repository via HTTPS
139146starlet-setup username/repo
@@ -164,10 +171,11 @@ starlet-setup username/repo --verbose
164171# Custom CMake args
165172starlet-setup username/repo --cmake-arg=-DCMAKE_CXX_COMPILER=clang++
166173```
174+ </details >
167175
168- <br />
169176
170- ### Mono-Repo Mode
177+ <details >
178+ <summary ><h3 >Mono-Repo Mode</h3 ></summary >
171179
172180#### BUILD_LOCAL Usage
173181Mono-repo mode sets ` BUILD_LOCAL=ON ` in the root project's CMakeLists.txt.
@@ -256,11 +264,10 @@ This structure allows you to:
256264- Build everything together
257265- Debug across module boundaries
258266- Commit changes without digging into build directories
267+ </details >
259268
260- <br />
261-
262- ### Profile Mode (Saved Configurations)
263- Save frequently used mono-repo configurations as named profiles for easy re-use.
269+ <details >
270+ <summary ><h3 >Profile Mode (Saved Configurations)</h3 ></summary >
264271
265272#### Managing Profiles
266273``` bash
@@ -285,18 +292,17 @@ starlet-setup username/repo --profile myprofile
285292# Use a profile with SSH
286293starlet-setup username/repo --profile myprofile --ssh
287294```
288-
289-
295+ </details >
290296
291297<br />
292298
293-
294-
295299## Development
300+ <details >
301+ <summary ><h3 >Developing starlet-setup</h3 ></summary >
296302
297303### Running Tests
298304
299- #### 1. Clone the Repository
305+ #### 1. Clone starlet-setup
300306``` bash
301307git clone https://github.com/masonlet/starlet-setup.git
302308cd starlet-setup
@@ -318,12 +324,12 @@ pytest tests/test_config.py
318324# Run tests with flags
319325pytest -v
320326```
321-
327+ </ details >
322328
323329
324330<br />
325331
326332
327333
328334## License
329- MIT License — see [ LICENSE] ( ./LICENSE ) for details.
335+ MIT License — see [ LICENSE] ( ./LICENSE ) for details.
0 commit comments