Chapter 1. Project Management

Sections

• Git and Github
• Document Your Project
  • What is a Documentation ?
  • Overview of of Documentation-Writting Tools
  • Using Markdown
  • Using Sphinx
  • Other Topics in the Future
• Work on the Server Machines
  • About Servers
  • ssh - Linking to the Server
  • Access to Remote Files

Lecture Slides & Resources

Section	Slides
Git and Github	PDF, video records
Document Your Project	PPT, video records
Work on the Server Machines	PPT

Prerequisites

The following softwares are required in this Chapter

• An Internet browser (e.g., Chrome, Firefox).

• A Python environment. Make sure that a python interpreter (>=3.5) is installed.

• Python package sphinx and sphinx-rtd-theme. Follow the section Start Your Sphinx Documentation to install them, so that the command sphinx-quickstart works.

• Shell commands, ssh, scp, rsync, sshfs and wget. Install them using the package manager of your local system, e.g., apt-get in a Ubuntu distribution.