-
You may choose to clone this repository, and then set the remote to a private repository of your own. Otherwise, an easier option is to simply download the repository as a zip file, and upload the contents to your own private repository.
-
Please DO NOT FORK this repository to do your lab work. Forks of this repository will be public, exposing your work to the internet. Submissions of code from public repositories will be considered plagiarism, even if they're your own repository!
-
Educators are welcome to fork this repository (and all others in this organisation) for their own teaching.
-
Create a separate folder to contain a Vivado project, which you can use for Lab 2 through 4.
-
Use the GitHub Releases and Milestones functions to mark your progress. We suggest creating a release for every lab assignment, with your code submission zip file as the release file.
You must have Python 3.12 or greater installed on your machine. Older versions are not guaranteed to work.
The environment is tested on Windows with WSL, macOS, and multiple Linux distributions. I have no idea if it will work on a native Windows environment - it should, but I haven't and do not intend to try.
You may choose to use uv, Anaconda, or just plain old pip to set up the development environment.
Clone the repository to your machine to get started. The instructions below will assume you have a terminal opened, and the current working directory is the cloned repository.
Simply run uv sync. This will read pyproject.toml and install all the required dependencies.
To run the development server, run uv run -- mkdocs serve.
Create a new conda environment to run mkdocs, let's say by running conda create -n mkdocs-env.
Switch to the new conda environment by running conda activate mkdocs-env.
Install mkdocs by running conda install mkdocs-material.
To run the development server, run mkdocs serve.
Create a new virtual environment using python -m venv .venv.
Activate the new virtual environment using source .venv/bin/activate. Use activate.csh, activate.fish or activate.ps1 as required by whatever shell you use.
Install the requirements by running pip install -r requirements.txt.
To run the development server, run mkdocs serve.
NUS CG3207 Lab Assignments © 2024 by NUS CG3207 Team is licensed under CC BY-NC-SA 4.0