Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mwood77 committed Feb 12, 2024
1 parent 17f3733 commit 8b6ca8b
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 3 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
</p>
</div>

> ### What's OSWW?
> [!NOTE]
> What's OSWW?
> - OSWW is an open source modular watch winder, which you can read more about on [GitHub](https://github.com/mwood77/osww) or [Printables](https://www.printables.com/model/421249-osww-the-open-source-watch-winder).

Expand Down Expand Up @@ -66,9 +67,19 @@
1. [Winderoo Wiring Diagram](./docs/wiring-diagram.md)


## Developer Resources
## Contributing
This project welcomes contributions. Please follow the regular git workflow; fork + PR to contribute.

### Translations / Localization
Winderoo has multi-language support, and we welcome adding more langauges.

To add another language:
1. Duplicate one of the current localizations, and translate the text.:
- `src/angular/osww-frontend/src/assets/i18n/` stores the current localizations.
1. Add a new menu item to enable your langauge in:
- `src/angular/osww-frontend/src/app/header/header.component.html`
1. Open a Pull Request

### Frontend
- Angular with Angular Material
- [Frontend Readme](./src/angular/osww-frontend/README.md)
Expand Down
Binary file added docs/gui/language.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gui/overview_v0.1.0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/gui/overview_v1.0.0.png
Binary file not shown.
Binary file modified docs/gui/reset.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion docs/user-manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

| v1.0.0 | |
| :---: |:---: |
|<img src="gui/overview_v1.0.0.png" height="600"> | This is winderoo's primary interface. From here you can change any settings you need |
|<img src="gui/overview_v0.1.0.png" height="600"> | This is winderoo's primary interface. From here you can change any settings you need |


### Enable / Disable Winding
Expand All @@ -18,6 +18,7 @@
| UI Element | Function |
| :---: |:---: |
|<img src="gui/reset.png" > | This is will open a pop-up window, which will ask you to confirm reset, and walk you through the reset proceedure. Use this to change the WiFi network Winderoo connects to. |
|<img src="gui/language.png" > | This will open a pop-up menu where you can select which language you'd prefer. |

### Status Bar
| UI Element | Function |
Expand Down

0 comments on commit 8b6ca8b

Please sign in to comment.