victoriadrake / open-mscs

Based on OMSCS. 🎓 Collaborative open source notes for graduate computer science courses.

The Open MSCS 🎓

The open source compendium of graduate computer science course notes.

I built Open MSCS to house and share my course notes, study tips, and resources for OMSCS. You can browse and easily search the site at https://openmscs.com/.

Contributing

📣 Calling all contributors! Contributions welcome! Additions, updates, corrections, and improvements of all kinds! 😄

Many heads are better than one! Feel free to open a pull request with your contribution, or an issue to request one from the community. You'll get a friendly, no-pressure environment -- whether it's your first or thousandth-and-first open source contribution!

Getting Started

You don't need to follow these steps unless you want to set up the repository on your own machine for local development. To browse the site, just visit the link above!

The site is built from the Markdown files under docs/ using MkDocs and the Material theme.

1. Clone this repository:

   git clone https://github.com/victoriadrake/open-mscs.git

2. Optionally, create your virtual environment.

3. You'll need Python, pip, and pipenv. Check that you have the first two with:

   python --version
   pip --version

   See instructions here for installing pipenv, optionally using pipx. Usually, you can just do pip install pipenv.

4. Install dependencies:

   pipenv install
   pre-commit install

Open the docs/ folder in your favorite editor. You're ready to add or update notes!

Local Development

You can run the local development server with mkdocs serve. Read the MkDocs documentation for more options.

Committing

The pre-commit framework you installed as part of the set up will run a Git hook that lints your Markdown files according to the .markdownlint-cli2.jsonc. This helps to keep things uniform and tidy.

Support

For help with this website or repository, please open an issue.

For help with OMSCS, come chat with your classmates!