Create initial GETTING_STARTED.md

This is the very first draft
This commit is contained in:
sporeball 2023-05-20 08:46:15 -07:00 committed by Conrad Kramer
parent 3c226c81cc
commit bf36a822a0

22
docs/GETTING_STARTED.md Normal file
View file

@ -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