38 lines
1.8 KiB
Markdown
38 lines
1.8 KiB
Markdown
# Nim-status-client
|
|
|
|
Desktop client for the [Status Network](https://statusnetwork.com/) built with [Nim](https://nim-lang.org/) and [Qt](https://www.qt.io/)
|
|
|
|
|
|
|
|
*note: this documentation is wip*
|
|
|
|
### Getting started
|
|
* [Building Nim-Status-Client](https://github.com/status-im/nim-status-client/blob/master/docs/building.md)
|
|
|
|
### Overview
|
|
* [QML Crash Course](https://github.com/status-im/nim-status-client/blob/master/docs/qml_crash_course.md)
|
|
* [NimQml](https://github.com/status-im/nim-status-client/blob/master/docs/qml_nim_communication.md)
|
|
|
|
### Architecture & Development
|
|
* [Project Architecture & Structure](https://github.com/status-im/nim-status-client/blob/master/docs/structure.md)
|
|
* [Common development errors aand how to solve them](https://github.com/status-im/nim-status-client/blob/master/docs/common_errors.md)
|
|
* [tips & tricks](tips.md)
|
|
|
|
### Guides & Tutorials
|
|
* [Tutorial - how to add a new section](https://github.com/status-im/nim-status-client/blob/master/docs/tutorial_adding_section.md)
|
|
* [Tutorial - how to create a custom QML component](https://github.com/status-im/nim-status-client/blob/master/docs/tutorial_custom_component.md)
|
|
|
|
### Continuous Integration
|
|
* [CI Readme](./ci/README.md)
|
|
* [Jenkins Jobs](https://ci.status.im/job/nim-status-client/)
|
|
|
|
### API
|
|
* [QML Nim-Status-Client API reference](https://github.com/status-im/nim-status-client/blob/master/docs/qml_api.md)
|
|
|
|
### Translations
|
|
* [How to translate and use automatic scripts](https://github.com/status-im/nim-status-client/blob/master/scripts/translationScripts/README.md)
|
|
|
|
### License
|
|
|
|
Licensed under the [Mozilla Public License Version 2.0](https://github.com/status-im/nim-status-client/blob/master/LICENSE.md)
|