1- # {{PROJECT_NAME}}
1+ # Wobble
22
3- {{PROJECT_DESCRIPTION}}
3+ Centralized testing package for Cracking Shells
44
55## Installation
66
77### From Source
88
99``` bash
10- git clone https://github.com/CrackingShells/{{PROJECT_NAME}} .git
11- cd {{PROJECT_NAME}}
10+ git clone https://github.com/CrackingShells/Wobble .git
11+ cd Wobble
1212pip install -e .
1313```
1414
1515### From PyPI (when available)
1616
1717``` bash
18- pip install {{PROJECT_NAME}}
18+ pip install wobble
1919```
2020
2121## Quick Start
2222
23- ``` python
24- import {{PACKAGE_NAME }}
23+ ``` bash
24+ # Install wobble
25+ pip install -e .
26+
27+ # Run all tests
28+ wobble
2529
26- # Add basic usage example here
30+ # Run specific test categories
31+ wobble --category regression
32+ wobble --category integration
33+
34+ # Get help
35+ wobble --help
2736```
2837
2938## Development
@@ -32,8 +41,8 @@ import {{PACKAGE_NAME}}
3241
3342``` bash
3443# Clone the repository
35- git clone https://github.com/CrackingShells/{{PROJECT_NAME}} .git
36- cd {{PROJECT_NAME}}
44+ git clone https://github.com/CrackingShells/Wobble .git
45+ cd Wobble
3746
3847# Install in development mode
3948pip install -e .
@@ -45,11 +54,17 @@ npm install
4554### Running Tests
4655
4756``` bash
48- # Run all tests
49- python -m unittest discover tests
57+ # Run all tests with wobble
58+ wobble
5059
51- # Run specific test file
52- python -m unittest tests.test_basic
60+ # Run tests by category
61+ wobble --category regression
62+
63+ # Run with verbose output
64+ wobble --verbose
65+
66+ # Alternative: use unittest directly
67+ python -m unittest discover tests
5368```
5469
5570### Making Commits
@@ -66,9 +81,20 @@ git commit -m "fix: resolve issue with X"
6681git commit -m " docs: update README"
6782```
6883
84+ ## Documentation
85+
86+ Complete documentation is available in the [ docs/articles/] ( docs/articles/ ) directory:
87+
88+ - ** [ Getting Started] ( docs/articles/users/GettingStarted.md ) ** - Installation and basic usage
89+ - ** [ CLI Reference] ( docs/articles/users/CLIReference.md ) ** - Complete command reference
90+ - ** [ Test Organization] ( docs/articles/users/TestOrganization.md ) ** - Test categorization strategies
91+ - ** [ Integration Guide] ( docs/articles/users/IntegrationGuide.md ) ** - Repository integration
92+ - ** [ Architecture Overview] ( docs/articles/devs/architecture/Overview.md ) ** - System design
93+ - ** [ Contributing Guidelines] ( docs/articles/devs/contribution_guidelines/Contributing.md ) ** - Development workflow
94+
6995## Contributing
7096
71- We welcome contributions! Please see our [ Contributing Guide] ( ./CONTRIBUTING .md) for details on:
97+ We welcome contributions! Please see our [ Contributing Guide] ( docs/articles/devs/contribution_guidelines/Contributing .md) for details on:
7298
7399- Development workflow
74100- Code style guidelines
@@ -81,6 +107,6 @@ This project is licensed under the GNU Affero General Public License v3 - see th
81107
82108## Links
83109
84- - ** Homepage** : https://github.com/CrackingShells/{{PROJECT_NAME}}
85- - ** Bug Reports** : https://github.com/CrackingShells/{{PROJECT_NAME}} /issues
86- - ** Documentation** : [ Coming Soon ]
110+ - ** Homepage** : https://github.com/CrackingShells/Wobble
111+ - ** Bug Reports** : https://github.com/CrackingShells/Wobble /issues
112+ - ** Documentation** : [ docs/articles/ ] ( docs/articles/ )
0 commit comments