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

Add introduction to documentation #44

Open
sarumpaet opened this issue May 17, 2019 · 1 comment

Comments

Projects
None yet
2 participants
@sarumpaet
Copy link

commented May 17, 2019

The README is missing a quick introduction and feature set. This should be the very first lines. How does bmx7 work, very briefly? On what OSI layer? What software is similar? What are bmx's special/most noteworthy features? What are the differences to bmx6? (if someone gives those details here, I can create a PR)

In the GitHub project description (at the top of https://github.com/bmx-routing/bmx7 ) there should probably also be a link to the homepage or the README (which otherwise gets a bit lost below all the source files).

@luserx0

This comment has been minimized.

Copy link
Collaborator

commented Jun 11, 2019

To synopsize:

  • How does BMX7 work and on which OSI layer?
  • Similar Software
  • Cool features
  • Differences with bmx6

I empathize with getting lost with all the source files at the root tree of the repo. Moving them to an src destination would be much favorable.

If you have more questions related to bmx7 please post them here and they will all be answered (if the volume gets big enough we can create an FAQ)

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.