readme: clarified and separated readme #227
Merged
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
Contributor
hackaugusto
commented
May 25, 2021
•
hackaugusto
commented
- Moved development docs from README to CONTRIBUTING
- Made the instructions more concise
- Removed some outdated documentation, e.g. python 3.6 is no longer supported
- Made the README.rst a bit more concise.
- Also added a mention to the supported formats and a link to the issue for protobuf support which is currently in dev
hackaugusto
force-pushed
the
hacka-update-readme
branch
3 times, most recently
from
f5736cc to
e2bce21
Compare
hackaugusto
commented
May 25, 2021
| ------------ | ||
|
|
||
| Karapace requires Python 3.6 or later and some additional components in |
There was a problem hiding this comment.
I removed all of these and just added an instruction to run pip install -r requirements-dev.txt
hackaugusto
commented
May 25, 2021
| To build an installation package for your distribution, go to the root | ||
| directory of a Karapace Git checkout and run:: | ||
|
|
||
| python3 setup.py bdist_egg |
There was a problem hiding this comment.
eggs are being phased out. Just removed this and instructed to run pip setup.py install for source installations.
hackaugusto
commented
May 25, 2021
hackaugusto
commented
May 25, 2021
| To see descriptions of configuration keys see section ``config``. Here's an | ||
| example configuration file to give you an idea what you need to change:: | ||
|
|
||
| { |
There was a problem hiding this comment.
I removed this sample configuration and just added a link to the sample configuration in the repo. It's easier maintain a single example up-to-date.
hackaugusto
force-pushed
the
hacka-update-readme
branch
2 times, most recently
from
4322142 to
3152140
Compare
hackaugusto
commented
May 25, 2021
hackaugusto
force-pushed
the
hacka-update-readme
branch
2 times, most recently
from
89e0bdd to
b948905
Compare
tvainika
reviewed
May 26, 2021
hackaugusto
force-pushed
the
hacka-update-readme
branch
from
b948905 to
15ae549
Compare
moved documentation about development to the CONTRIBUTING.md file, and tried to make the README.rst a bit more concise.
hackaugusto
force-pushed
the
hacka-update-readme
branch
from
15ae549 to
4c8cacd
Compare
tvainika
approved these changes
May 27, 2021
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.