This repository holds the reference page for the course homepage for Computer Science Pragmatics, a course for early-career EECS students at the University of Michigan.

For more information, visit the course homepage: https://cspragmatics.com

The site itself uses GitHub Pages, Flask.

Before contributing, please check open issues and create a new issue if a one for your proposed contribution does not exist.

Content for the website is written in Markdown. To contribute to the reference page, navigate to reference/static/commands and then to the specific section and edit an existing .md file or create a new one. For example, to edit the cd reference, edit reference/static/commands/basics/cd.md.

In order to build the site locally on your computer, there are a number of dependencies to resolve first. Make sure you're in a python 3.7 virtual environment, then run the following in your terminal:

export FLASK_APP=reference
export FLASK_ENV=development
python setup.py develop
flask run

Alternatively, just run the setup script provided.

chmod +x run.sh
run.sh

For more information on setting up, see GitHub's guide or Flask's documentation.

After making a change and verifying that it works, please submit a pull request.

Computing for Computer Scientists by Pat Pannuto is licensed under a Creative Commons Attribution 4.0 International License.