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

102
docs/GETTING_STARTED.md
View file

@ -1,6 +1,5 @@
# Getting Started # Getting Started
## Dependencies ## Dependencies
Before you can start working on Burrow, you'll need to install some dependencies. They are different for each platform: Before you can start working on Burrow, you'll need to install some dependencies. They are different for each platform:
@ -8,60 +7,79 @@ Before you can start working on Burrow, you'll need to install some dependencies
<details> <details>
<summary>Linux</summary> <summary>Linux</summary>
1. Install **rustup** using the instructions on the [website](https://rustup.rs/): 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. Install **Visual Studio Code** from the [website](https://code.visualstudio.com/#alt-downloads), [Snap Store](https://snapcraft.io/code), or your package manager of choice. ```bash
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```
2. Install **Visual Studio Code** from the [website](https://code.visualstudio.com/#alt-downloads), [Snap Store](https://snapcraft.io/code), or your package manager of choice.
</details> </details>
<details> <details>
<summary>macOS</summary> <summary>macOS</summary>
1. Install **rustup** using the instructions on the [website](https://rustup.rs/): 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: ```bash
``` $ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
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. 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.
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>
<details> <details>
<summary>Windows</summary> <summary>Windows</summary>
1. Download **Visual Studio** community edition from the [website](https://visualstudio.microsoft.com/vs/). Install the components for "Desktop Development with C++" 1. Download **Visual Studio** community edition from the [website](https://visualstudio.microsoft.com/vs/). Install the components for "Desktop Development with C++"
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 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**: 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 ```posh
winget install LLVM.LLVM winget install Git.Git
winget install Rustlang.Rustup winget install LLVM.LLVM
``` winget install Rustlang.Rustup
```
4. Install Rust using rustup:
```posh
rustup toolchain install stable-msvc
```
4. Install Rust using rustup:
```posh
rustup toolchain install stable-msvc
```
</details> </details>
## Building ## Building
1. Clone the repository: 1. Clone the repository:
``` ```
git clone git@github.com:hackclub/burrow.git git clone git@github.com:hackclub/burrow.git
``` ```
2. Open the `burrow` folder in Visual Studio Code: 2. Open the `burrow` folder in Visual Studio Code:
``` ```
code burrow code burrow
``` ```
@ -74,37 +92,39 @@ code burrow
## Running ## Running
<details> <details>
<summary><b>Command Line</b></summary> <summary><b>Command Line</b></summary>
You can run burrow on the command line with cargo: You can run burrow on the command line with cargo:
``` ```
cargo run cargo run
``` ```
Cargo will ask for your password because burrow needs permission in order to create a tunnel.
Cargo will ask for your password because burrow needs permission in order to create a tunnel.
</details> </details>
<details> <details>
<summary><b>Visual Studio Code</b></summary> <summary><b>Visual Studio Code</b></summary>
You can debug the Rust program inside of Visual Studio using the **Run and Debug** tab. 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.
**_This does not work fully yet_**. Visual Studio Code does not have a way to debug programs with administrative privileges.
</details> </details>
<details> <details>
<summary><b>iOS or macOS</b></summary> <summary><b>iOS or macOS</b></summary>
You can run the Burrow app on iOS or macOS using **Xcode**. You can run the Burrow app on iOS or macOS using **Xcode**.
You will need to be logged in with your Apple ID, and it should be a part of **The Hack Foundation** team: You will need to be logged in with your Apple ID, and it should be a part of **The Hack Foundation** team:
<img style='max-width: 552px;' src="xcode.png"></img> <img style='max-width: 552px;' src="xcode.png"></img>
If your Apple ID is not a part of The Hack Foundation team, ask the Slack channel for assistance. 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**.
You should now be able to run the app by opening `Apple/Burrow.xcodeproj` in Xcode, selecting the **App** scheme and clicking **Run**.
</details> </details>