Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/victoriadrake/open-mscs
Based on OMSCS. 🎓 Collaborative open source notes for graduate computer science courses.
https://github.com/victoriadrake/open-mscs
computer-science cyberphysical-systems georgia-tech graduate graduate-course graduate-school information-security omscs omscs-courses
Last synced: about 2 months ago
JSON representation
Based on OMSCS. 🎓 Collaborative open source notes for graduate computer science courses.
- Host: GitHub
- URL: https://github.com/victoriadrake/open-mscs
- Owner: victoriadrake
- License: mit
- Created: 2021-04-28T23:55:35.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-14T18:52:45.000Z (8 months ago)
- Last Synced: 2024-05-02T05:32:05.032Z (8 months ago)
- Topics: computer-science, cyberphysical-systems, georgia-tech, graduate, graduate-course, graduate-school, information-security, omscs, omscs-courses
- Homepage: https://openmscs.com/
- Size: 10 MB
- Stars: 13
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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 .
## 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](https://github.com/victoriadrake/open-mscs/pulls) with your contribution, or an [issue](https://github.com/victoriadrake/open-mscs/issues) 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](https://www.mkdocs.org/) and the [Material theme](https://squidfunk.github.io/mkdocs-material/).
1. Clone this repository:
```sh
git clone https://github.com/victoriadrake/open-mscs.git
```
2. Optionally, [create your virtual environment](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments).
3. You'll need Python, `pip`, and `pipenv`. Check that you have the first two with:
```sh
python --version
pip --version
```
See instructions here for [installing `pipenv`](https://pipenv.pypa.io/en/latest/install/), optionally using `pipx`. Usually, you can just do `pip install pipenv`.
4. Install dependencies:
```sh
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](https://www.mkdocs.org/) for more options.
### Committing
The [pre-commit framework](https://pre-commit.com/) you installed as part of the set up will run a [Git hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks) 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](https://github.com/victoriadrake/open-mscs/issues).
For help with OMSCS, come [chat](https://openmscs.com/#quick-links) with your classmates!