-
Notifications
You must be signed in to change notification settings - Fork 3
Home
Documentation in HIRo occurs in 3 different places: Github wiki, HIRo website, and project's repo.
This is where you can find all official documentation about our system. It includes all the essential, up-to-date tutorials and instructions to operate the hardware and manage the software.
It also provides a temporary place to document the current project(s) because it's easier for all project members to find documentation on Github Wiki. However, Github wiki is not a place to document previous projects (old projects' documentation should stay within their own repos). That said, after each project ends, its documentation on Github Wiki has to be re-organized and then moved to the project's repo page via a pull request. Old projects on Github Wiki will be deleted when the next semester starts.
The team website is hosted on Github page using Forestry.io as a middle-man service to build and maintain the site. The site is used to showcase our team's previous projects to the outside audience. A project post on this site needs to explain the high-level implementation of the project with polished videos and images and provide a project's repo URL (source code).
Branch hosted: hiro/gh-pages
Forestry.io instruction: https://github.com/olinrobotics/hiro/wiki/Github-Page-with-Forestry.io
Post example: https://olinrobotics.github.io/hiro/projects/math-problem-solving/
Please contact the current team leader to gain permission to the Forestry platform.
Old projects' repos should stay in hiro_archive folder. This is where the source code of your project lives. Each project should have a README that
- describes the program (with a link to the project on Github page)
- explains the structure of the code (for example, what are the classes, and how are they related?)
- describes how to install and run the program including versions of required software and the OS you tested on
- lists contributors
Project README example: https://github.com/olinrobotics/hiro/tree/master/hiro_archive/Spring_2018_Project_Gemini/Perception
Github Wiki pages are written in the Markdown language. The language is a format-based language, much like HTML. It's fairly easy to write, and most of the work involves looking up what you want to do and copying the formatting of the code that you find. Github has a nice bar with buttons for quite a few different functions that you can use. Additionally, Markdown Cheatsheet has a general page for basic Markdown commands that is useful. To access the Markdown file for a given GitHub page, click the "Edit" button (next to the "New Page" button) on the right-hand side of the website.
- Install Ubuntu 16.04: https://github.com/olinrobotics/hiro/wiki/Tutorial:-Ubuntu-Installation
- How to use Linux Terminal: https://github.com/olinrobotics/hiro/wiki/Tutorial:-Linux-Terminal
- Atom & Pycharm: https://github.com/olinrobotics/hiro/wiki/Tutorial:-Atom-&-Pycharm-IDE
- Learn Robot Operating System (ROS): https://github.com/olinrobotics/HIRo/wiki/Tutorial:-ROS
- Learn OpenCV: https://github.com/olinrobotics/hiro/wiki/Tutorial:-Basic-OpenCV
- Intro to Git: https://github.com/olinrobotics/HIRo/wiki/Tutorial:-Git
If you need help, come find Merwan Yeditha [email protected] or Audrey Lee [email protected]!