status-im
/
status-desktop
mirror of https://github.com/status-im/status-desktop.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
status-desktop/docs/README.md

38 lines
1.8 KiB
Markdown
Raw Normal View History

readme: update title to match repo name Signed-off-by: Jakub Sokołowski <jakub@status.im>
2021-03-25 20:50:08 +00:00
# Status-desktop
include screenshot in the readme
2020-06-30 20:30:10 +00:00
docs: indicate MPL 2.0 as the license
2020-09-23 17:22:05 +00:00
Desktop client for the [Status Network](https://statusnetwork.com/) built with [Nim](https://nim-lang.org/) and [Qt](https://www.qt.io/)
include screenshot in the readme
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)
add docs and tutorials add docs and tutorials add test index update readme update readme
2020-06-22 13:25:24 +00:00
*note: this documentation is wip*
move building section to docs section; use readme from docs/readme move building section to docs section; use readme from docs/readme use symlink fix urls
2020-06-22 13:59:09 +00:00
### Getting started
update readme
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)
add docs and tutorials add docs and tutorials add test index update readme update readme
2020-06-22 13:25:24 +00:00
move building section to docs section; use readme from docs/readme move building section to docs section; use readme from docs/readme use symlink fix urls
2020-06-22 13:59:09 +00:00
### Overview
update readme
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)
move building section to docs section; use readme from docs/readme move building section to docs section; use readme from docs/readme use symlink fix urls
2020-06-22 13:59:09 +00:00
### Architecture & Development
update readme
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)
add docs and tutorials add docs and tutorials add test index update readme update readme
2020-06-22 13:25:24 +00:00
* [tips & tricks](tips.md)
move building section to docs section; use readme from docs/readme move building section to docs section; use readme from docs/readme use symlink fix urls
2020-06-22 13:59:09 +00:00
### Guides & Tutorials
update readme
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)
add docs and tutorials add docs and tutorials add test index update readme update readme
2020-06-22 13:25:24 +00:00
add Jenkinsfiles and Dockerfile for CI Changes: - Adds `ci/Dockerfile` for creating `statusteam/nim-status-client-build:latest` used in builds - Adds `ci/Jenkinsfile.linux` and `ci/Jenkinsfile.macos` for respective platforms - Simplifies MacOS signing by adding `scripts/sign-macos-pkg.sh` script - Makes `Makefile` use `scripts/sign-macos-pkg.sh` to make the DMG - Makes `APPIMAGE` and `DMG` in `Makefile` modifiable by environment - Adds `--passL:"-headerpad_max_install_names"` to `NIM_PARAMS` to fix MacOS signing issues Signed-off-by: Jakub Sokołowski <jakub@status.im>
2020-06-18 16:44:22 +00:00
### Continuous Integration
* [CI Readme](./ci/README.md)
docs: indicate MPL 2.0 as the license
2020-09-23 17:22:05 +00:00
* [Jenkins Jobs](https://ci.status.im/job/nim-status-client/)
add Jenkinsfiles and Dockerfile for CI Changes: - Adds `ci/Dockerfile` for creating `statusteam/nim-status-client-build:latest` used in builds - Adds `ci/Jenkinsfile.linux` and `ci/Jenkinsfile.macos` for respective platforms - Simplifies MacOS signing by adding `scripts/sign-macos-pkg.sh` script - Makes `Makefile` use `scripts/sign-macos-pkg.sh` to make the DMG - Makes `APPIMAGE` and `DMG` in `Makefile` modifiable by environment - Adds `--passL:"-headerpad_max_install_names"` to `NIM_PARAMS` to fix MacOS signing issues Signed-off-by: Jakub Sokołowski <jakub@status.im>
2020-06-18 16:44:22 +00:00
move building section to docs section; use readme from docs/readme move building section to docs section; use readme from docs/readme use symlink fix urls
2020-06-22 13:59:09 +00:00
### API
update readme
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)
feat: add readme on how to use the translation script
2020-07-06 19:29:05 +00:00
### Translations
* [How to translate and use automatic scripts](https://github.com/status-im/nim-status-client/blob/master/scripts/translationScripts/README.md)
docs: indicate MPL 2.0 as the license
2020-09-23 17:22:05 +00:00
### License
Licensed under the [Mozilla Public License Version 2.0](https://github.com/status-im/nim-status-client/blob/master/LICENSE.md)