Priprava na izdajo: dokumentacija in inkrement verzije
This commit is contained in:
23
README.md
23
README.md
@@ -49,14 +49,16 @@ Projekcija/
|
||||
|
||||
### Requirements
|
||||
- Python 3.8+
|
||||
- Flask (for web interface)
|
||||
- **Tkinter** (usually included with Python, but may require `python3-tk` on some Linux distributions)
|
||||
- **Flask** (for web interface)
|
||||
- `sqlite3` (included with Python)
|
||||
- `requests` (for remote database updates and notifications)
|
||||
|
||||
### Setup
|
||||
|
||||
1. **Install Dependencies**:
|
||||
```bash
|
||||
pip install flask
|
||||
pip install flask requests
|
||||
```
|
||||
|
||||
2. **Configure Settings**:
|
||||
@@ -96,11 +98,12 @@ python projector.py
|
||||
|
||||
### Special Commands (Input as song number)
|
||||
|
||||
- **9999**: Shutdown system
|
||||
- **9998**: Restart system
|
||||
- **9999**: Shutdown system (Windows/Linux)
|
||||
- **9998**: Restart system (Windows/Linux)
|
||||
- **9997**: Restart application
|
||||
- **9988**: Exit application
|
||||
- **9901**: Update songs database from `db_update_url`
|
||||
- **9900**: Show application information (version, author, license)
|
||||
|
||||
### Configuration
|
||||
|
||||
@@ -112,8 +115,11 @@ Edit `settings.json` to customize:
|
||||
- **screen_width_percent**: Width of the text area (e.g., 60)
|
||||
- **font_bold**: Use bold font (true/false)
|
||||
- **show_song_info**: Show song number and page info at bottom (true/false)
|
||||
- **split_by_stanza**: If true, each stanza starts on a new page (true/false)
|
||||
- **web_port**: Port for web interface (0 to disable)
|
||||
- **db_update_url**: URL for remote database synchronization
|
||||
- **ntfy_topic**: Topic for ntfy.sh notifications
|
||||
- **installation_label**: Custom label for the installation (shown in app info)
|
||||
|
||||
### Web Interface
|
||||
|
||||
@@ -132,14 +138,17 @@ Features:
|
||||
|
||||
## API Endpoints
|
||||
|
||||
- `GET /api/state` – Current projector state
|
||||
- `GET /api/state` – Current projector state (text, page info, modes)
|
||||
- `GET /api/events` – SSE endpoint for real-time update notifications
|
||||
- `GET /api/app_info` – Application metadata (version, author, song count)
|
||||
- `POST /api/load_song` – Load a song by number
|
||||
- `POST /api/next_page` – Next page
|
||||
- `POST /api/prev_page` – Previous page
|
||||
- `POST /api/clear_screen` – Clear display
|
||||
- `POST /api/toggle_caps` – Toggle uppercase
|
||||
- `POST /api/search_songs` – Search songs
|
||||
- `GET /api/get_song_details` – Get lyrics for editing
|
||||
- `POST /api/toggle_split` – Toggle stanza split mode
|
||||
- `POST /api/search_songs` – Search songs by title
|
||||
- `GET /api/get_song_details` – Get lyrics and title for editing
|
||||
- `POST /api/update_song` – Save song changes or create new
|
||||
|
||||
## Testing
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "Projekcija",
|
||||
"description": "Aplikacija za projekcijo besedil pesmi na zaslon.",
|
||||
"version": "0.6.91",
|
||||
"version": "0.7.0",
|
||||
"authors": [
|
||||
"Uroš Urbanija (izvorna zasnova)",
|
||||
"Valentin Korenjak (nadgradnje in vzdrževanje)"
|
||||
|
||||
Reference in New Issue
Block a user