This is the main repository for the project. It is structured in a "monorepo" style to contain multiple related sub-projects (see PR #169). Other repositories which are part of the project are:
- cs-education/sysassets - Pre-compiled assets used in the project, such as lecture videos, lessons, man pages, and the jor1k filesystem.
We use GitHub Pages for hosting the application. The repositories used for deployment are separate from this repository, to keep this repository small. You probably won't be committing changes directly to these repositories, but instead use automated deployment scripts. The following repositories are used for deployment:
-
cs-education/sys-staging - Staging deployment for the C playground web app, used for testing before deploying to production
-
cs-education/sys - Production deployment for the C playground web app
-
Set up Git and install Node.js. Node's package manager (npm) comes bundled.
-
Fork this repository. Clone your forked Git repository:
git clone https://github.com/<your-username>/sysbuild.git -
Navigate to the newly cloned directory:
cd sysbuild/ -
Install project-wide dependencies. This will also run the setup script to create the recommended Git remotes and install Git hooks:
npm install
Also check out the C Playground's getting started docs!. Next, head to the Development Workflow guide.