Add getting started and dependencies to README

[ryancoe]

@nickross4444 - Can you please add section(s) to the README that explain how to get started and list necessary dependencies that are not included with the repo? I particular, this should help someone like me, who hasn't run the GUI in a while, get everything connected and running.

[nickross4444]

@delaneyheileman Do you know if there are any external dependencies besides the IDEs? I know all the basic arduino and processing libraries are included in the repo.

[SeanPluemer]

I have added a requirement section to the README that shows what IDE and dependencies are required however, I have encountered some problems.

• I don't know why it wasn't working if it was something I was doing it or this computer. Either way, I cant directly copy the libraries from SIWEED over to my instance of Arduino/processing IDE. I had to search through the library manager and manually add all of them individually.

• Another problem that I encountered is I was unable to figure out how to run the GUI without being connected to an Arduino.

  • When I try to run SiweedGUI I get an ArrayIndexOutofBoundsException:1 error related to the ports for the connections to the Arduino. I will update this when I get access to an Arduino.

[nickross4444]

@SeanPluemer for arduino and Processing, you need to change the sketchbook location to the siweed related directories. In both IDEs this is done by clicking file>preferences, and selecting the arduino or processing folder that is in the siweed repository.

I will look into the ArrayIndexOutofBoundsException.

[nickross4444]

@SeanPluemer Are you sure you're using the develop branch? master does not have the most recent updates.

[SeanPluemer]

@nickross4444 I did change the sketchbook location to their siweed related directories with still no luck. What appears to have worked was actually installing the Arduino IDE. I was running the "zip file for non-admin install" with no luck, but now that I have installed it, I appear to be getting further. I am able to GUI working now, but the scale is off and I am getting some missing font errors. See the pictures below.

This screenshot is my entire desktop, as you can see I cant see the top nor move the window.

[nickross4444]

@SeanPluemer Glad to see it's working. The font issues are normal, but I'm sure we can find some way to fix that. We can talk to @delaneyheileman about the sizing.

[delaneyheileman]

@SeanPluemer @nickross4444 I can fix the font issue this week. It should be an easy fix. Did it once before quar but those changes never got pushed.

[ryancoe]

@SeanPluemer - Here's an example of a very nice README.md for a software/hardware project https://github.com/pachterlab/poseidon

[DeepFriedDerp]

@SeanPluemer, after following up on the questions from Monday's meeting with @ryancoe, the following conclusions were made:

1. Authors list : Leave this out of the readme, and let github's automated contributors list take care of that. We can update this in the future if necessary.
2. Code of Conduct : Leave this out of the readme for now, if something like this is needed prior to going public, then Sandia will ensure that Sandia-specific verbiage is there.
3. Licensing Info : @ryancoe has an action item to choose the appropriate license.

[ryancoe]

@SeanPluemer - Your updates look great in general. Thanks very much for using examples to inform your work on the README! Please make the changes suggested by @DeepFriedDerp.

[SeanPluemer]

I believe the readme revamp is good for now and this issue can be closed. I will continue to update it as time goes on, but the specific details listed in this issue have been updated (Getting started, dependencies, and GUI).