From bf36a822a0d09a2226e598995105c1e7f0a7e9e3 Mon Sep 17 00:00:00 2001 From: sporeball Date: Sat, 20 May 2023 08:46:15 -0700 Subject: [PATCH] Create initial GETTING_STARTED.md This is the very first draft --- docs/GETTING_STARTED.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/GETTING_STARTED.md diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md new file mode 100644 index 0000000..108d6bf --- /dev/null +++ b/docs/GETTING_STARTED.md @@ -0,0 +1,22 @@ +# Getting Started + +## Linux +- Clone the repository. +- Install Rust using [rustup](https://rustup.rs). +- Open the project folder in [Visual Studio Code](https://code.visualstudio.com). + +At this point, there are two options to open a new tunnel. + +### Method 1: Run & Debug +- Install the [CodeLLDB](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb) VS Code extension. +- In VS Code, press F5 to run & debug Burrow.\ +This flow does not work yet (panics). + +### Method 2: Cargo +- In VS Code, press Ctrl+\` to open the terminal. +- Type `cargo run`. +- Burrow should open a new tunnel (`Ok("tun0")`), then exit. + +## macOS + +## Windows