Fixed some errors in README.md.

This commit is contained in:
Storm Dragon
2025-10-22 12:25:22 -04:00
parent 33ae752333
commit 16c0d2932b

View File

@@ -263,60 +263,5 @@ BookStorm uses a dual TTS system for text books:
- **Book Reading (Piper-TTS mode)**: piper-tts → WAV → pygame.mixer (high quality) - **Book Reading (Piper-TTS mode)**: piper-tts → WAV → pygame.mixer (high quality)
- **Book Reading (Speech-Dispatcher mode)**: Separate speech-dispatcher session (faster, system voices) - **Book Reading (Speech-Dispatcher mode)**: Separate speech-dispatcher session (faster, system voices)
Audio books use pygame.mixer.music for streaming playback with chapter-based navigation.
## Project Structure
```
bookstorm/
├── bookstorm.py # Main entry point
├── README.md # This file
├── CLAUDE.md # Developer documentation
├── check_naming.py # Code style validator
└── src/
├── daisy_parser.py # DAISY 2.02 & 3 parser
├── epub_parser.py # EPUB parser
├── pdf_parser.py # PDF text extractor
├── txt_parser.py # Plain text parser
├── audio_parser.py # Audio book parser
├── bookmark_manager.py # SQLite bookmark storage
├── speech_engine.py # Speech-dispatcher wrapper
├── tts_engine.py # Piper-TTS wrapper
├── pygame_player.py # Audio playback engine
├── config_manager.py # Settings management
├── options_menu.py # Interactive menu system
├── voice_selector.py # Voice browsing/testing
├── book_selector.py # File browser
├── recent_books_menu.py # Recent books menu
├── sleep_timer_menu.py # Sleep timer
├── audiobookshelf_client.py # Audiobookshelf API client
├── audiobookshelf_menu.py # Server browser interface
├── server_sync.py # Progress synchronization
└── bookmark_sync.py # Bookmark synchronization
```
## Contributing
BookStorm follows specific naming conventions:
- **Variables & Parameters**: camelCase
- **Functions & Methods**: snake_case
- **Classes**: PascalCase
Before committing changes, run the naming validator:
```bash
python check_naming.py
```
See `CLAUDE.md` for detailed developer documentation.
## License
[Add your license information here]
## Credits
BookStorm was created for the blind and visually impaired community, with a focus on accessibility-first design.
## Support
For issues and feature requests, please visit https://git.stormux.org/storm/bookstorm For issues and feature requests, please visit https://git.stormux.org/storm/bookstorm