Update README #43
Merged
Update README #43
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
|
Ok sure will do |
|
Actually we have a few documentation pages for MPF that are also outdated now. I don't think it's a good idea to have the same info in the readme and in the docs, so how about we use the readme only for developer info and describe everything users need to know in the docs? |
|
In general, I agree, but I'd still keep a very high-level overview in the README, with a link to the doc site. Dropping the install section in favor of the more detailed doc site is fine, though. |
|
Good to merge? |
|
Yes go ahead |
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.
README was very outdated. @arthurkehrwald if you could update the Setup section and in general add whatever you feel is missing, that'd be awesome.