Helpful Resources¶
GitHub and Git¶
- https://guides.github.com
- Git basics: https://git-scm.com/book/en/v2/Getting-Started-Git-Basics
- The super simple beginners guide to Git: http://rogerdudler.github.io/git-guide/
- Understanding the workflow of git version control: https://www.git-tower.com/learn/cheat-sheets/vcs-workflow
- Guidance to git commands you may need in the command line: https://www.git-tower.com/blog/git-cheat-sheet/
Python¶
Structuring large Python projects¶
- Python documentation on what package, module, script are: https://docs.python.org/3/tutorial/modules.html
- Simple example of this structure and how it is documented: https://github.com/brandon-rhodes/sphinx-tutorial/blob/master/triangle-project/trianglelib
Writing Code: Python Conventions & Documentation¶
- Overall guide to documentation in Python http://docs.python-guide.org/en/latest/writing/documentation/
- The PEP8 on writing your code keeping to convention (supported by PyCharm): https://www.python.org/dev/peps/pep-0008/
- The PEP257 on documenting your code: https://www.python.org/dev/peps/pep-0257/
- Handling errors with exceptions and raising errors: https://docs.python.org/2/tutorial/errors.html
Differences between Python 2 and Python 3¶
- http://sebastianraschka.com/Articles/2014_python_2_3_key_diff.html
- Porting code from Python 2 to Python 3: https://docs.python.org/3/howto/pyporting.html
Python commands¶
pyclean .will clean the current directory of _pycache_ and .pyc
reStructuredText & Sphinx Markup¶
The documentation for this project is written in reStructuredText format. To assist this, the following resources should be acknowledged:
- RST Cheatsheet: https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst
- RST Reference: http://docutils.sourceforge.net/docs/user/rst/quickref.html
- RST Directives: http://docutils.sourceforge.net/docs/ref/rst/directives.html
- Sphinx’s RST Primer: http://www.sphinx-doc.org/en/stable/rest.html
- Official Sphinx Markup Constructs: http://www.sphinx-doc.org/en/stable/markup/
Sphinx & Read The Docs¶
The following resources were useful in the setting up of Sphinx and Read The Docs for this project:
- Screencast: https://www.youtube.com/watch?v=oJsUvBQyHBs
- RTD Guide: https://docs.readthedocs.io/en/latest/getting_started.html
- Documenting a project with Sphinx (lecture): https://www.youtube.com/watch?v=QNHM7q2hLh8
Getting Started with ROS¶
To ‘get started’ with learning ros, you may find doing the following helps you to understand ROS better:
- In your home directory, ensure you have set up a complete catkin workspace.
- Within that workspace, create a catkin package.