Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing: Added steps to install rust and cargo #16

Merged
merged 2 commits into from
Oct 21, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -77,23 +77,46 @@ git remote add upstream https://github.com/scribe-org/Scribe-Desktop.git
- `origin` (forked repository)
- `upstream` (Scribe-Desktop repository)

2. (Optional) Install [pre-commit](https://pre-commit.com/) and its hooks to check for and correct common errors in commits:
2. Install Rust and Cargo:

- For Linux and macOS:

Run the following command in your terminal:

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

Follow the on-screen instructions to complete the installation. You can find more details in the [official Rust documentation](https://doc.rust-lang.org/book/ch01-01-installation.html).

- For Windows:

Download and run [rustup-init.exe](https://rustup.rs/). Follow the instructions in the installer. For more details, visit the [Rust Windows installation guide](https://www.rust-lang.org/tools/install).

After installation, you may need to restart your terminal for the changes to take effect. Verify the installation by running:

```bash
rustc --version
cargo --version
```

3. (Suggested) Install [pre-commit](https://pre-commit.com/) and its hooks to check for and correct common errors in commits:

```bash
pip install pre-commit
pre-commit install
# pre-commit run --all-files
```

3. Run the following to spin up a local copy of the Scribe-Desktop GUI:
4. Run the following to spin up a local copy of the Scribe-Desktop GUI:

```bash
cd scribe
cargo build
cargo run --bin scribe
```

4. You may need to give your terminal or IDE permission for your keyboard strokes to be read
5. You may need to give your terminal or IDE permission for your keyboard strokes to be read
- You may also need to restart the application and then run `cargo run --bin scribe` again

> [!NOTE]