Table of Contents

• Getting Started
• Development

Hi! Welcome to JuCC.

1. GitHub We use GitHub for all our development.
   • Account Sign up for a GitHub account.
2. OS Make sure you are running Ubuntu 20.04. If not, the recommended approach is to dual boot or to use a VM.
3. IDE We recommend Visual Studio Code.
4. Packages Install using
   • Go to the folder: cd ~/jucc/script/installation
   • Install all the necessary packages: sudo bash ./packages.sh

You should learn a little about the following:

1. git
2. C++ and how we use it

• We try our best to list all available options in CMakeLists.txt. Search for # HEADER CMake options and global variables.

• You should know these targets.
  • jucc: Building will build the jucc binary and all its dependencies.
  • jucc_benchmark: Building will build and link the jucc object file to the benchmark library. Running will run the benchmarks.
  • test: Building will run all unit tests using gtest. This will not show specifics of failed test, run build/bin/jucc_test for detailed info.
  • format: Building will run the formatter clang-format on the codebase with our rules. Use this every time right before you commit and right before you make a pull request!
  • check-format: Building will check if the codebase is correctly formatted according to clang-format with our rules.
  • check-clang-tidy: Building will check if the codebase passes the clang-tidy static analyzer tests with our rules.
  • check-lint: Building will check if the codebase passes the build-support/cpplint.py checks.

If you run into issues, you may need your default python to point to a python3 install. For example, add this to your ~/.zshrc: alias python=python3

1. Check out the latest version of the JuCC repository.
   • git checkout main
   • git pull upstream main
2. Create a new branch.
   • git checkout -b my_new_branch
3. Work on your code. Add features, add documentation, add tests, add remove bugs, and so on.
4. Push your code.
   • Make sure you run tests locally! See below.
   • git push -u origin my_new_branch
5. Go to GitHub and open a new pull request.
6. When a pull request is opened, this triggers our Continuous Integration environment on circle-ci.
   • CI will clone the repo, apply your changes, and make sure that formatting, linting, tests, etc pass.
   • Code has to pass all the checks for it to be merged!

Use make test or ninja test to run inside your build folder to run all tests.

For detailed test info:

1. Go to the folder: cd ~/JuCC/build
2. Generate optimized config with cmake -GNinja .. -DCMAKE_BUILD_TYPE=Release
3. Build project with ninja
4. Run ./bin/jucc_test

1. Go to the folder: cd ~/JuCC/build
2. Generate optimized config with cmake -GNinja .. -DCMAKE_BUILD_TYPE=Release
3. Build project with ninja
4. Run ./bin/jucc_benchmark [...options]