Skip to main content

Setting up Stepdance Course Github repository and Project Website​

The creative motion control course is dependent on peer learning. To facilitate this, uou are responsible for documenting all work you produce in this course in two forms:

  1. Documenting all code you write in the SSL on a Github Repository
  2. Documenting the prototyping, interaction, and output of all machines you develop on a Github.io pages site.

This repository is your project portfolio for the Creative Motion Control course. You will use it to store code and documentation for each project you complete.

All code and project documentation will be stored in your team repository in the course github organization github.com/Creative-Motion-Control-Course

Follow these instructions to setup your documentation"

Repository Structure​

projects/
  project1/
    code/          ← Your Arduino/C++ code
    docs/
      index.md     ← Project write-up (text, images, video)
      assets/      ← Images and media filesgi
  project2/
    ...

Getting Started​

  1. Create a new repository in the Creative-Motion-Control github organization with your team name.
  2. Clone the cmc_sample_template repository to your local computer. Add the remote origin as your new repository with your team name:
git remote remove origin
git remote add origin git@github.com:Creative-Motion-Control-Course/<YOUR_REPO_NAME>.git
git branch -M main
git push -u origin main
  1. Enable GitHub Pages: Go to your repo's Settings → Pages, set Source to GitHub Actions.

IMPORTANT You may need to first set your repository visibility to public. Otherwise you will not be able to enable Github Pages. To do so select Settings>General and scroll to the bottom to change the repo visibility.

  1. Update the front page: Modify the index.md file with your team name and Team Member Bios and pictures.
  2. Start a new project: All code and documentation for your first project should live in the projects/project1/ folder. (There is a project2 folder for your final).
  3. Add your code: Place your Arduino .ino and any supporting .h/.cpp files in the code/ folder.
  4. Write your documentation: Edit docs/index.md to describe your project, embed images and video.
  5. Update the home page: Add a link to your new project in index.md at the repo root.
  6. Push to GitHub: Your documentation site will automatically deploy to https://<your-username>.github.io/<repo-name>/.

Writing Documentation​

Each project's docs/index.md is a Markdown file that supports:

  • Images: Place files in docs/assets/ and reference them: 
    ![Description](assets/my-image.jpg)
  • Embedded video (YouTube, Vimeo, etc.): 
    <iframe width="560" height="315" src="https://www.youtube.com/embed/VIDEO_ID" frameborder="0" allowfullscreen></iframe>

Note, you should not upload videos directly to github as they are generally too large to handle effectively. Instead upload them to Vimeo or YouTube and embed them as shown above.

Resources​