Remill Workshop

Setting up the environment

This repository uses a devcontainer.json file to allow you to quickly get started. Below are two methods of setting up the environment. Using Codespaces is recommended.

1) GitHub Codespaces (easy)

Login to your GitHub account
Fork this repository
Click the green <> Code button
Press ... and then New with options...
Change Machine type to 4-core
Then Create codespace
Wait a ~3 minutes while the image is loading ☕
- Press Show log to see progress

Note: Remember to shut down your codespace here when you're finished.

_{Alternatively you can set things up locally with Docker Desktop (not recommended):}

Docker Desktop (tricky)

Install/Update Docker Desktop (alternatives)
Start Docker Desktop
Install Visual Studio Code
Clone and open this repository in VS Code (use the HTTPS protocol)
Install the Dev Containers extension in VS Code (you should be prompted for recommended extensions)
Click the blue 'Reopen in Container' button when prompted (you can also find it in the command palette)

For more detailed steps, check out the Dev Containers tutorial. The instructions after this assume you are running inside the container.

Windows

Because the host filesystem is mounted inside the container you may need to configure Git to not automatically convert line endings:

git config --global core.autocrlf false

Additionally it's recommended to configure Docker to use the WSL 2 backend.

2) Building the examples

To build the project, press the Build button in the status bar:

You will be prompted for a preset, select clang and the build will start:

Alternatively you can build with the following commands:

cmake --preset clang
cmake --build build

3) Checking the environment

To verify if the environment is set up correctly, run:

llvm-config --prefix

Expected output:

/cxx-common/install

The ${workspaceFolder}/build directory will also be added to your PATH, so you can easily access your tools from anywhere. To verify, run the follow command:

hello

Expected output:

remill version: e72a100

afjoseph / RemillWorkshop