Skip to content

Commit

Permalink
Add artifact warning to documentation and swap out cargo emoji (#599)
Browse files Browse the repository at this point in the history
  • Loading branch information
blakehatch committed Jan 8, 2024
1 parent d5443c8 commit 89eafed
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 4 deletions.
30 changes: 28 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Supports Unix-based operating systems and Windows.
Below, you will find a few different options for getting started with Native Link.


### 🦀 Installing with Cargo
### 📦 Installing with Cargo

```bash
cargo install --git https://github.com/TraceMachina/nativelink --tag v0.2.0
Expand Down Expand Up @@ -121,7 +121,20 @@ bazel run --config=windows nativelink -- $(pwd)/nativelink-config/examples/basic
bazel run --config=windows -c opt nativelink -- $(pwd)/nativelink-config/examples/basic_cas.json
```

## 🦀 Building with Cargo
> [!WARNING]
> The Rust compiler (rustc) generates numerous artifacts during compilation,
> including dependencies, macros, and intermediate files.
> When compiling programs from source, be mindful of the associated files'
> impact on your disk usage in the bazel-bin/ directory.
> This directory can grow substantially in size.
>
> If the facing issues due to this, run the following command
> to clear cache files:
> ```sh
> bazel clean --expunge
> ```
## 📦 Building with Cargo

**Build requirements:**

Expand All @@ -140,6 +153,19 @@ cargo run --bin nativelink -- ./nativelink-config/examples/basic_cas.json
cargo run --release --bin nativelink -- ./nativelink-config/examples/basic_cas.json
```

> [!WARNING]
> The Rust compiler (rustc) generates numerous artifacts during compilation,
> including dependencies, macros, and intermediate files.
> When compiling programs from source, be mindful of the associated files'
> impact on your disk usage in the target/ directory.
> This directory can grow substantially in size.
>
> If the facing issues due to this, run the following command
> to clear cache files:
> ```sh
> cargo clean
> ```
## 🚀 Example Deployments

You can find a few example deployments in the [deployment-examples directory](./deployment-examples).
Expand Down
36 changes: 34 additions & 2 deletions nativelink-docs/docs/Quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: 'Getting started with NativeLink remote execution in <5 minutes.'
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## 🦀 Installing with Cargo
## 📦 Installing with Cargo

Install or Update Rust

Expand Down Expand Up @@ -207,7 +207,23 @@ The `--release` flag causes link-time-optmization to be enabled, which can take

:::

## 🦀 Building with Cargo
:::warning

The Rust compiler (rustc) generates numerous artifacts during compilation,
including dependencies, macros, and intermediate files.
When compiling programs from source, be mindful of the associated files'
impact on your disk usage in the bazel-bin/ directory.
This directory can grow substantially in size.

If the facing issues due to this, run the following command
to clear cache files:
```sh
bazel clean --expunge
```

:::

## 📦 Building with Cargo

**Build requirements:**

Expand All @@ -229,6 +245,22 @@ cargo run --bin cas -- ./nativelink-config/examples/basic_cas.json
cargo run --release --bin cas -- ./nativelink-config/examples/basic_cas.json
```

:::warning

The Rust compiler (rustc) generates numerous artifacts during compilation,
including dependencies, macros, and intermediate files.
When compiling programs from source, be mindful of the associated files'
impact on your disk usage in the target/ directory.
This directory can grow substantially in size.

If the facing issues due to this, run the following command
to clear cache files:
```sh
cargo clean
```

:::

## ❄️ Installing with Nix

**Installation requirements:**
Expand Down

0 comments on commit 89eafed

Please sign in to comment.