hackclub/burrow
1
0
Fork 0
Code Pull requests Releases Packages Activity Actions 4

Added Xcode Path Switching to Getting Started

Browse source
This commit is contained in:
Jasper Mayone 2024-01-26 01:33:26 -05:00 • committed by GitHub
parent 079c4f676d
commit 9e03c9680c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 61 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/GETTING_STARTED.md
View file

@ -1,6 +1,5 @@
# Getting Started
## Dependencies
Before you can start working on Burrow, you'll need to install some dependencies. They are different for each platform:
@ -9,6 +8,7 @@ Before you can start working on Burrow, you'll need to install some dependencies
<summary>Linux</summary>
1. Install **rustup** using the instructions on the [website](https://rustup.rs/):
```bash
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
@ -20,19 +20,32 @@ Before you can start working on Burrow, you'll need to install some dependencies
<summary>macOS</summary>
1. Install **rustup** using the instructions on the [website](https://rustup.rs/):
```bash
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2. Download and install **Visual Studio Code** from the [website](https://code.visualstudio.com/#alt-downloads), or by using brew:
```
brew install --cask visual-studio-code
```
3. Download and Install **Xcode** from the [App Store](https://apps.apple.com/us/app/xcode/id497799835) or the [Apple Developer](https://developer.apple.com/downloads) website.
</details>
4. Make sure the _"current"_ version of Xcode matches the one you are using:
```
$ xcode-select -p
```
If the output is not the version of Xcode you just installed, run the following command to switch to the new version:
```
$ sudo xcode-select -s {PATH_TO_XCODE}
```
</details>
<details>
<summary>Windows</summary>
@ -42,6 +55,7 @@ Before you can start working on Burrow, you'll need to install some dependencies
2. Install [**Visual Studio Code**](https://apps.microsoft.com/store/detail/visual-studio-code/XP9KHM4BK9FZ7Q), [**PowerShell**](https://apps.microsoft.com/store/detail/powershell/9MZ1SNWT0N5D) and [**Windows Terminal**](https://apps.microsoft.com/store/detail/windows-terminal/9N0DX20HK701) from the Microsoft Store
3. Open Windows Terminal and use [winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/) to install **git**, **LLVM** and **rustup**:
```posh
winget install Git.Git
winget install LLVM.LLVM
@ -49,19 +63,23 @@ Before you can start working on Burrow, you'll need to install some dependencies
```
4. Install Rust using rustup:
```posh
rustup toolchain install stable-msvc
```
</details>
## Building
1. Clone the repository:
```
git clone git@github.com:hackclub/burrow.git
```
2. Open the `burrow` folder in Visual Studio Code:
```
code burrow
```
@ -74,7 +92,6 @@ code burrow
## Running
<details>
<summary><b>Command Line</b></summary>
@ -85,6 +102,7 @@ code burrow
```
Cargo will ask for your password because burrow needs permission in order to create a tunnel.
</details>
<details>
@ -93,6 +111,7 @@ code burrow
You can debug the Rust program inside of Visual Studio using the **Run and Debug** tab.
**_This does not work fully yet_**. Visual Studio Code does not have a way to debug programs with administrative privileges.
</details>
<details>
@ -107,4 +126,5 @@ code burrow
If your Apple ID is not a part of The Hack Foundation team, ask the Slack channel for assistance.
You should now be able to run the app by opening `Apple/Burrow.xcodeproj` in Xcode, selecting the **App** scheme and clicking **Run**.
</details>