Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation refactor #45

Open
wants to merge 12 commits into
base: master
from

Conversation

Projects
None yet
2 participants
@luserx0
Copy link
Collaborator

commented Jun 13, 2019

Changes:

  • Moved source to to src/ directory
  • Split documentation from main README into doc/ and added Debugging directives
  • Substitutes the string bmx6 with bmx7 whenever applicable
  • Ported HOWTO and HOWTO.txt to README.md and prettified them
  • Generic typo fixes and Markdown prettifications whenever applicable
  • Add .editorconfig file at the head of root demonstrating current practises
  • Fix root README.md
  • Add FAQ.md doc ~~> Add FAQ Section on root README.md
  • Include the BMX7 logo as the repo's banner

TODOs:

  • Fill the FAQ with answers and questions (#help-needed)
  • Include more information on Debugging.md
  • Maybe transfer the last three portions of Usage.md to Concepts.md (?)

Notes:

  • The changes below contain some whitespace and empty line changes. This can be reverted immediately and will be to match the scope of the PR
Show resolved Hide resolved doc/Plugins.md Outdated
Show resolved Hide resolved doc/Plugins.md Outdated
Show resolved Hide resolved src/lib/bmx7_json/README.md Outdated

luserx0 added some commits Jun 13, 2019

Show resolved Hide resolved README.md

luserx0 added some commits Jun 15, 2019

Various changes
- Fix ToC, 
- add FAQ section, 
- add Packages section, 
- include logo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.