Create a README - Githubissues

howardabrams commented 6 years ago

Include the following sections:

Introduction We could describe the need and purpose of the project.
Requirements What hardware is currently needed to be attached to a Raspberry Pi? What additional software needs to be installed first?
Installation How to install on a Raspberry Pi in such a way that we can download a Robotpy-compatible source code, and have it find and use our library as if it was using the RobotPy library on a RoboRIO. Perhaps we could eventually write a script to do the installation (and the dependencies mentioned in the Requirements section), but we should write them first so we know what we want to do.
Example Let's have an example of source code that actually works on a Raspberry Pi with our library ... this is especially nice since we may not be implementing the entire library at this time.
Caveats and Exceptions What is different for code written for the RPi and our library vs. the RoboRIO with RobotPy?

This will be important when we open this to be a public project and attempt to get credit from the judges for outreach and other awards.

calebeby commented 6 years ago

How about if we just create a Raspberry Pi iso, so people can have the system set up right away. It's pretty easy to create an iso, you just set up a card how you want it and then copy the snapshot to the computer.

I think it's

dd if=/dev/sdX of=output.iso bs=4m

howardabrams commented 6 years ago

I agree. I already have that all set up. But for some people who want to replicate our work, we may want to have both.

On Sep 22, 2017, at 11:38 AM, Caleb Eby notifications@github.com wrote:

How about if we just create a Raspberry Pi iso, so people can have the system set up right away. It's pretty easy to create an iso, you just set up a card how you want it and then copy the snapshot to the computer.

I think it's

dd if=/dev/sdX of=output.iso bs=4m — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Pigmice2733/PiRobotPy/issues/4#issuecomment-331528047, or mute the thread https://github.com/notifications/unsubscribe-auth/AAejjQZlz0tmSkEoau4HDhRWc45S7_3Uks5sk_6jgaJpZM4PhD7r.

pchickey commented 6 years ago

There is a basic README now, I suggest we close this mega-bug and open up a bunch of smaller bugs to take care of the details that are currently missing. Since we are still a ways of development away from having answers to some of these questions, it would be helpful to break these down into smaller pieces so we post the answers to what we do know as we learn it.

Pigmice2733 / PiRobotPy

Create a README #4