search

gnuradio / pybombs

PyBOMBS (Python Build Overlay Managed Bundle System) is the GNU Radio install management system for resolving dependencies and pulling in out-of-tree projects.
https://gnuradio.org
GNU General Public License v3.0
414 stars 191 forks source link

created an actual quickstart #590

Closed 777arc closed 3 years ago

777arc commented 3 years ago

Might not work under every platform, but having these commands at the top will be a nice reference for folks

jkbecker commented 3 years ago

Interesting, that could be helpful.

Personally, I think the README is way too long and should be broken up into a short, super concise intro and then a series of pages in the Wiki section that explain individual features. In that case, your quick start would be a good fit for the main README...

But we haven't really discussed that yet AFAIK... what does @argilo think about this?

777arc commented 3 years ago

Well Barry did a good job of overhauling the README and adding a lot of important content, I personally don't care whether it lives in the README or on the wiki. That being said, I know there are folks out there who get upset when docs are stored in the wiki but don't live locally to their install, like when I moved the GR usage manual to the wiki I exported a snapshot and pushed it to the main repo for that reason.

jkbecker commented 3 years ago

Ah, fair points. Just to be clear, I think the whole README is great content, I just think it gets a bit lengthy. Another alternative could be to move things in a number of Markdown files in a /docs/ directory and have the main README contain a quickstart + linked TOC?