diff options
| author | Paul Buetow <paul@buetow.org> | 2025-06-22 16:55:09 +0300 |
|---|---|---|
| committer | Paul Buetow <paul@buetow.org> | 2025-06-22 16:55:09 +0300 |
| commit | 2a39cbd5a50209d66820d2a833f25a48868a909a (patch) | |
| tree | a6ed87a43093e47cf98982812ccf040a1ff8ed61 | |
| parent | 7e2f6f2a927a249327be28442b2c7b78b74850a9 (diff) | |
Add screenshot and documentation index to README
- Added screenshot2.png to show DS-Sim's visual interface
- Added prominent link to documentation index (docs/index.md)
- Updated documentation section with correct lowercase filenames
- Updated protocol list to remove Raft reference
- Improved documentation section with emoji and clearer structure
Users can now immediately see what DS-Sim looks like and easily navigate
to the complete documentation.
🤖 Generated with Claude Code
https://claude.ai/code
Co-Authored-By: Claude <noreply@anthropic.com>
| -rw-r--r-- | IDEAS.md | 9 | ||||
| -rw-r--r-- | README.md | 22 |
2 files changed, 14 insertions, 17 deletions
diff --git a/IDEAS.md b/IDEAS.md deleted file mode 100644 index 968b07e..0000000 --- a/IDEAS.md +++ /dev/null @@ -1,9 +0,0 @@ -# ideas - -* Allow simulations of arbitrary length - -## Protocols - -* Voter sets according to Maekawa? -* NFS -* AFS @@ -2,6 +2,8 @@ DS-Sim is a modern, open-source simulator for distributed systems, written in Java. It provides a powerful environment for simulating and learning about distributed systems concepts. + + ## Features - Protocol simulation @@ -118,7 +120,7 @@ mvn clean package -DskipTests ### Test Coverage - **Core components**: VSTask, VSMessage, process management - **Event system**: Event handling and registration -- **Protocol implementations**: PingPong, Raft consensus +- **Protocol implementations**: PingPong, Two-Phase Commit, Berkeley Time, etc. - **Total**: 141 unit tests (headless-compatible) ### Protocol Simulation Testing @@ -232,9 +234,10 @@ ds-sim/ │ │ └── utils/ # Utilities and helpers │ └── resources/ # Configuration files ├── docs/ # Documentation -│ ├── ARCHITECTURE.md # System architecture and design -│ ├── DEVELOPER_GUIDE.md # Guide for extending DS-Sim -│ └── TIMESTAMP_EVENTS_GUIDE.md # Timestamp event system +│ ├── index.md # Documentation index +│ ├── architecture.md # System architecture and design +│ ├── developer-guide.md # Guide for extending DS-Sim +│ └── testing-guide.md # Comprehensive testing guide ├── saved-simulations/ # Example simulation files ├── scripts/ # Development scripts └── pom.xml # Maven configuration @@ -242,10 +245,13 @@ ds-sim/ ## Documentation -- **[Architecture Guide](docs/ARCHITECTURE.md)** - System design, components, and diagrams -- **[Developer Guide](docs/DEVELOPER_GUIDE.md)** - How to create new protocols and events -- **[Timestamp Events Guide](docs/TIMESTAMP_EVENTS_GUIDE.md)** - Using timestamp-triggered events -- **[CLAUDE.md](CLAUDE.md)** - Build commands and project overview +📚 **[Full Documentation Index](docs/index.md)** - Complete list of all documentation + +### Key Documents: +- **[Architecture Guide](docs/architecture.md)** - System design, components, and diagrams +- **[Developer Guide](docs/developer-guide.md)** - How to create new protocols and events +- **[Testing Guide](docs/testing-guide.md)** - Comprehensive testing documentation +- **[Timestamp Events Guide](docs/timestamp-events-guide.md)** - Using timestamp-triggered events ## Contributing |