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

Jump to bottom

doc: add git setup description #12

Open
wants to merge 1 commit into
base: open-source
Choose a base branch
from
+10 −0
Open

doc: add git setup description #12

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
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,16 @@ sudo ./usertools/lf-ipc.py --cmd=<command> {--params=<parameters>}

# Develop

To develop on LightningFilter, fork the repository, and clone it onto your machine. If you want to contribute to the open-source repository, we recommend adding the open-source repository as the upstream for the main branch (`open-source`):

```
git checkout open-source
git remote add upstream [email protected]:netsec-ethz/lightning-filter.git
git fetch upstream
git branch --set-upstream-to upstream/open-source
git pull
```

To get quickly started with developing LightningFilter, we provide a Development Container setup (`.devcontainer/devcontainer.json`) with all required dependencies and some useful tools.
When using VS Code, just install the [Visual Studio Code Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension and open the project in a container (`>Dev Container: Reopen in Container`).

Expand Down