Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): update developing instructions #750

Merged
merged 1 commit into from
Sep 18, 2024
Merged

fix(docs): update developing instructions #750

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 17 additions & 5 deletions docs/07-Contributing/developing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,24 @@ The easiest way to set up your Development Environment is to use the provided Gi

## Environment Config

- Download [Helm](https://helm.sh/)
- [Go](https://go.dev/doc/install)
- Docker
- [Helm](https://helm.sh/docs/intro/install)
- jq: `sudo apt install jq`
- Fork the repository
- If you want to use [ghcr.io](https://github.com/features/packages) as container registry, login following instructions [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic)

### LLVM/Clang Installation

To manually configure your DevEnv:
To manually configure your DevEnv you will need `llvm-strip` and `clang`.

To install `clang`:

```bash
sudo apt install clang-16
```

To install `llvm-strip`:

```bash
export LLVM_VERSION=16
Expand All @@ -24,15 +35,16 @@ curl -sL https://apt.llvm.org/llvm.sh | sudo bash -s "$LLVM_VERSION"
Test that `llvm-strip` and `clang` are in your `PATH`:

```bash
which llvm-strip
which clang
which llvm-strip
```

If these commands fail (there is no output), then see if you have a binary with the version as a suffix (e.g. `/usr/bin/llvm-strip-16`).
If these commands fail (there is no output), then see if you have a binary with the version as a suffix (e.g. `/usr/bin/clang-16` and `/usr/bin/llvm-strip-16`).
Then create a symbolic link to the versioned binary like:

```bash
ln -s /usr/bin/llvm-strip-16 /usr/bin/llvm-strip
sudo ln -s /usr/bin/clang-16 /usr/bin/clang
sudo ln -s /usr/bin/llvm-strip-16 /usr/bin/llvm-strip
```

## Building and Testing
Expand Down
Loading