discuss-gnuradio
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Discuss-gnuradio] PyBOMBS documentation recommendations


From: Barry Duggan
Subject: Re: [Discuss-gnuradio] PyBOMBS documentation recommendations
Date: Sun, 10 Nov 2019 09:56:20 -0500
User-agent: Roundcube Webmail/1.3.8

Hi Marc,

As I begin to dig into the PyBOMBS docs, I will have lots of questions.

-   Who best can answer those questions?

- What media should we use for the questions: email, Slack #docs, Discuss-gnuradio?

- How would I propose changes to the pybombs/README.md? With a pull request? If that is the case, it would make more sense to me to work on the InstallingGR#Using_PyBOMBS page first, and then get it into the pybombs/README.md.

Do you have other thoughts or suggestions as I get started?

Thanks,
---
Barry Duggan KV4FV


On 2019-11-07 22:50, Marc Lichtman wrote:
I 100% agree, and I also think the PyBOMBS' github page's README would be
the logical place to put it.

-Marc

On Thu, Nov 7, 2019 at 10:12 PM Barry Duggan <address@hidden> wrote:

Greetings,

I have found four URLs giving instructions on using PyBOMBS:
<pre>
https://wiki.gnuradio.org/index.php/InstallingGR#Using_PyBOMBS
https://github.com/gnuradio/pybombs/README.md
https://github.com/gnuradio/gnuradio/README.md

https://www.gnuradio.org/blog/2016-06-19-pybombs-the-what-the-how-and-the-why/
</pre>

In various comments in Discuss-gnuradio, I have concluded that most of
the PyBOMBS users who have failed were due to using old or incomplete
instructions. Also I think that most new users read the
InstallingGR#Using_PyBOMBS instructions only.

As an advocate of having a single place to document instructions, I
highly recommend picking one site for those instructions, and then
having links to that page from all others. From what I see, the
https://github.com/gnuradio/pybombs/README.md page seems to be the
logical choice since it is revised as PyBOMBS is revised.

If you choose to have the
https://wiki.gnuradio.org/index.php/InstallingGR#Using_PyBOMBS page
contain the current instructions as well, I can convert the
pybombs/README.md instructions to Mediawiki and put them in
InstallingGR#Using_PyBOMBS.

Once you have decided what you want done, I can take care of the edits,
if you would like.

Best regards,
--
Barry Duggan KV4FV




reply via email to

[Prev in Thread] Current Thread [Next in Thread]