status-desktop/docs/README.md

29 lines
1.4 KiB
Markdown
Raw Normal View History

# Nim-status-client
2020-06-30 20:30:10 +00:00
![https://github.com/status-im/nim-status-client/blob/master/docs/screenshot.png](https://github.com/status-im/nim-status-client/blob/master/docs/screenshot.png)
*note: this documentation is wip*
### Getting started
2020-06-22 14:31:47 +00:00
* [Building Nim-Status-Client](https://github.com/status-im/nim-status-client/blob/master/docs/building.md)
### Overview
2020-06-22 14:31:47 +00:00
* [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
2020-06-22 14:31:47 +00:00
* [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
2020-06-22 14:31:47 +00:00
* [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
2020-06-22 14:31:47 +00:00
* [QML Nim-Status-Client API reference](https://github.com/status-im/nim-status-client/blob/master/docs/qml_api.md)