sepehr/Entropyk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: create comprehensive documentation and deep-dive examples

Browse Source 
- Created DOCUMENTATION.md covering core philosophy, modules, and platform specifics.
- Created EXAMPLES_FULL.md with complex multi-platform usage scenarios.
- Updated README.md and docs/index.md to centralize documentation links.
This commit is contained in:
Sepehr
2026-02-21 23:25:04 +01:00
parent fa480ed303
commit 56df96ed9e
4 changed files with 208 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -37,10 +37,9 @@ Then visit [http://localhost:3030](http://localhost:3030) in your browser.
- `ui/`: Web-based interface for visual modeling.
- `docs/`: Technical documentation and tutorials.
## Documentation
- **[Comprehensive Documentation](./DOCUMENTATION.md)**: The definitive guide to Entropyk features and architecture.
- **[Exhaustive Examples](./EXAMPLES_FULL.md)**: Deep-dive code samples for all platforms (Rust, Python, C).
- **[Tutorial](./docs/TUTORIAL.md)**: Step-by-step guide to using the library and UI.
- **[Examples](./EXAMPLES.md)**: Detailed code snippets for each component.
- **[Full Index](./docs/index.md)**: Directory of all project documentation.
## License