From 7f779d8dfe6d041ad5fb31552c9e3c0912fb617e Mon Sep 17 00:00:00 2001 From: Fabio Streun Date: Sat, 20 May 2023 09:20:32 +0000 Subject: [PATCH] add git setup description --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1a04def..1de27b1 100644 --- a/README.md +++ b/README.md @@ -135,6 +135,16 @@ sudo ./usertools/lf-ipc.py --cmd= {--params=} # 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 git@github.com: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`).