Conversation
Added a brief notice elaborating on the reference to this project and kratom. Also added a listing of the required Python package versions as per `requirements.txt`. Giving visitors an easy overview of the requirements is a nice thing to do.
Wrote up some basic installation instructions covering how to install and run as well as venv creation and `requirements.txt` use. I feel that should be fairly comprehensive for most uses. No idea how well they translate to operating systems other than Linux, I will need to look into that. In the future, we may want to elaborate this a bit more. Add a few sentences between each block of commands to explain what is going on. Some users may not want or need a venv, for example. A more verbose instruction may prevent issue for some.
ncdulo
added
documentation
7 tasks
Merged
Owner
Author
|
Leaving a note regarding the branch deletion.. I can reuse the same name in the future, that was why I originally kept the branch. To continue work on this issue maintaining the same PR. However, I will have issues trying to push this branch to the future if I re-create it using the same name due to origin references. The solution is when creating the next feature branch to work on this -- use a different one. Use |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Beginning to undertake a larger overall re-write of
README.md. I've decided to keep the work in a running feature branch so that I can swap back to working in other areas as need be. Due to the fact that the readme is a forward-facing part of this project, I am going to continually merge it intomasterafter a visual check on GitHub.The full re-write should not take a huge amount of time. I would like to work on it without rushing, and have quicker results, while not cluttering the
masterbranch.Will the PR stay the same, or will I need to make new ones? We shall soon find out.
Edit: This PR is in response to Issue #9