add begining of docs for editor #144
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gaspard--
reviewed
Jul 28, 2019
| The albinos configuration editor works in a complementary way with `albinos daemon service`. | ||
|
|
||
| The albinos editor binary comes with a dynamic library containing albinos API functionality, | ||
| This way when a client enters a command the function is directly called from the `DLL`. |
There was a problem hiding this comment.
I4d object to the use of DLL since that may be confusing as it is primarly used for windows.
Gaspard--
reviewed
Jul 29, 2019
Gaspard--
approved these changes
Jul 29, 2019
| Below is the list of prerequisites to compile albinos-editor on your machine: | ||
|
|
||
| * Nim version 0.18 minimum | ||
| * Nimble |
There was a problem hiding this comment.
Maybe add instructions on how to get this. Isn't as straightforward as you make it out to be.
This is mostly because as far I know most package managers don't provide nimble.
A simple link to the official download or something like that would suffice.
|
|
||
| ## Getting Started | ||
|
|
||
| These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system. |
|
I Will still update this pull request, please dont merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.