This site is made with Jekyll and published with GitHub Pages. Be sure to read up on both Jekyll and Using Jekyll with Pages before contributing.
To get started:
-
Clone this repository
git clone https://github.com/mah-dv/ia-oop-python.git cd ia-oop-python
-
Install dependencies
gem install bundle # ignore if bundle is already installed bundle install
-
Build & preview the site locally at
0.0.0.0:4000
bundle exec jekyll serve # add --watch for auto-regeneration
Now you're ready to start contributing!
git checkout -b fix#123 # Create a new branch
# Fix stuff!
git add .
git commit . -m "message" # Commit changes
git checkout master
git pull # Fetch remote changes
git merge fix#123 # Merge changes to master
git push origin master # Push changes to github
# (Optional)
git branch -D fix#123 # Delete local branch
Adding a new course:
- Add the new course in
_data/courses.yml
. - Create course file in
_data/
, ex._data/me105a.yml
. - Create a new directory in
courses/
, ex.courses/me105a/
. - Create the course main page
index.md
and the needed subdirectories for assignments, exercises, projects and lectures.
Preview existing courses for example files.
All content is available under a Creative Commons Attribution 4.0 license. In most cases, this should be equal to the generic version. Attribution in the form of a link to http://mah-webb.github.io/ is much appreciated.