Add info/documentation to Readme and addition docs in folder /docs and documentation in folder /docs/img/

fossasia / pslab-hardware

PSLab Hardware Design and Schematics https://pslab.io

Apache License 2.0

1.64k stars 92 forks source link

Add info/documentation to Readme and addition docs in folder /docs and documentation in folder /docs/img/ #6

Closed mariobehling closed 7 years ago

mariobehling commented 7 years ago

Let's follow the same structure of documentation as in our software projects. Please add additional information into Readme.md e.g. chat channel, communication, project structure, best practices and images.

Also keep documentation images for the project in /docs/img/.

A good example for documentation in a repository is here: https://github.com/fossasia/open-event-orga-server

mariobehling commented 7 years ago

@jithinbp Please add some more info and images to the Readme.md.

mariobehling commented 7 years ago

Please do the following

[ ] add hardware images to Readme.md.
[ ] Use international English for punctuation and spelling
[ ] complete the parts list and provide links to parts
[ ] correct the markup of links
[ ] Merge section hardware specs and section Feature list for the acquisition and control and explain the purpose of each hardware spec/item

jithinbp commented 7 years ago

@mariobehling I have a query -

For the last three items on the list , are you perhaps referring to the repo 'pslab-firmware' ? The parts list is currently in the Readme.md of pslab-firmware . I'm moving it to this repo's readme.md

mariobehling commented 7 years ago

Let's put things where they belong (of course sometimes there is an overlap).

Please see it from a developer perspective: "I am a young developer who sees this project. I find it interesting. I do not know so much about hardware development. I am just starting. What do I need to build this hardware and start developing?"

Please provide all details and info here. Cheers.

jithinbp commented 7 years ago

thanks!

On Mon, Apr 17, 2017 at 4:48 PM, Mario Behling notifications@github.com wrote:

Closed #6 https://github.com/fossasia/pslab-hardware/issues/6 via 2a38f1d https://github.com/fossasia/pslab-hardware/commit/2a38f1d211f87d8f50a713e9bc125cfae99b3dbd .

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/fossasia/pslab-hardware/issues/6#event-1044869954, or mute the thread https://github.com/notifications/unsubscribe-auth/AFzAwhP43yAW1X1R3vFn4jU6IyeWO2tSks5rw0ptgaJpZM4M3dCp .

-- jithin