Skip to content

Commit

Permalink
Update README for more clarity (#803)
Browse files Browse the repository at this point in the history
  • Loading branch information
nfarah86 authored Mar 28, 2024
1 parent b6d4427 commit 31a1bf1
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/styles/config/vocabularies/TraceMachina/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ blazingly
mutex
parsable
rebase
remoteable
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ Supports Unix-based operating systems and Windows.

Below, you will find a few different options for getting started with NativeLink.

### 📝 Clone the NativeLink repository
1. Go to the [NativeLink](https://github.com/TraceMachina/nativelink) repository on GitHub. Clone the repository via SSH or HTTPS. In this example the repository is cloned via SSH:
```bash
git clone [email protected]:TraceMachina/nativelink.git
```

### 📦 Installing with Cargo

Expand Down Expand Up @@ -43,10 +48,12 @@ nativelink basic_cas.json

## 🧪 Evaluating NativeLink

Once you've built NativeLink and have an instance running with the
`basic_cas.json` configuration, launch a separate terminal session and run the
following command to connect the running server launched above to Bazel or
another RBE client:
1. Once you've built NativeLink and have an instance running with the `basic_cas.json` configuration, launch a separate terminal session.
2. Navigate to where you cloned the NativeLink repository:
```bash
cd $HOME/nativelink
```
3. In the new terminal, run the following command to connect the running server launched above to Bazel or another RBE client:

```sh
bazel test //... \
Expand All @@ -68,6 +75,9 @@ bazel test //... `
This causes Bazel to run the commands through an all-in-one `CAS`, `scheduler`
and `worker`.

> [!WARNING]
> If you're using MacOS, encountering errors is anticipated at this stage. Our team is actively working on enhancing support for executing remoteable Bazel builds with MacOS. For now, you can run with [Docker](https://github.com/blakehatch/nativelink/tree/main/deployment-examples/docker-compose) or a Linux virtual machine. If you have any questions, reach out on the [NativeLink](https://join.slack.com/t/nativelink/shared_invite/zt-2forhp5n9-L7dTD21nCSY9_IRteQvZmw) slack.
## How it Works

This diagram is a high-level overview of the data flow in the NativeLink system. It refers to NativeLink concepts like Scheduler pool, Worker pool, and CAS rather than the cloud concepts like functions, compute nodes, and object storage to which they correspond.
Expand Down

0 comments on commit 31a1bf1

Please sign in to comment.