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

feedback on documentation #7

Open
nlooije opened this issue Dec 21, 2016 · 1 comment
Open

feedback on documentation #7

nlooije opened this issue Dec 21, 2016 · 1 comment

Comments

@nlooije
Copy link

nlooije commented Dec 21, 2016

I hope you won't take this as negative feedback on an otherwise awesome project but i'd like to use this issue to identify some discrepancies with the documentation.

  1. The Bill of Materials in the 'useful information' and 'step-by-step' guide differ for some important materials. Also using the BoM from the step-by-step guide will e.g. not get you enough T-brackets to complete the build.
  2. The instructions for the linear stage towards the end of document require more specific instructions. From the text and the pictures it is still too vague how certain parts should be attached. Also is there a template for making holes into the perspex?
  3. There is no documentation on the installation of the Arduino and/or RPi software. E.g. several Adafruit libraries are required to be installed. Also no mention is made anywhere of a Touchscreen in the documentation but the Arduino software requires a Touchscreen library. How is this Touchscreen used?

I may append to this list as i find more while i am finishing my build...

@JamesRitchie
Copy link
Member

JamesRitchie commented Jan 3, 2017

You're right, the documentation is definitely a problem. I've been intermittently writing some better documentation for the software parts, so I'll see what I can put together, but it's been a few years since I was an undergraduate and working on the project.

If you have any other questions let me know, I'll try and answer them or get in touch with the people who might know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants
@JamesRitchie @nlooije and others