Improve the Toolkit's README #137
Open
Conversation
This file contains hidden or 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
…d in a cleaner way.
|
Maybe add how exactly to add the environment variables (PYTHONPATH) with an example. |
|
Is this PR dead? If so I'd be interested in reusing it to open a fresh PR. I think there's some good info here that the project would benefit from having in its README. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This patch modifies the ACI toolkit's README file so it contains a bit more information and looks cleaner. Since this is often the first thing that newcomers see, I think it's beneficial to work a bit on the messaging and the look&feel. It also adds a "Contributing" section encouraging users to clone the repository and extend it to their needs.