Skip to content

Commit

Permalink
Mention cross-compiling in README
Browse files Browse the repository at this point in the history
  • Loading branch information
athre0z authored and rockdaboot committed Jul 15, 2024
1 parent 638cd72 commit cbc100c
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
> [!NOTE]
>
> [!NOTE]
>
> Please be aware that we currently won't merge 3rd party PRs because this repository
> is temporary. We are waiting for the decision of the OpenTelemetry technical
> commitee on the donation of this repository.
Expand Down Expand Up @@ -42,8 +42,8 @@ agent to OpenTelementry.

## Building

> [!NOTE]
>
> [!NOTE]
>
> If you simply wish to take the agent for a spin with minimal effort, you can
> also immediately jump to the ["Visualizing data locally"
> section](#visualizing-data-locally), launch devfiler and follow the download
Expand All @@ -60,7 +60,11 @@ make docker-image

Then, you can build the agent:
```sh
# Build for architecture of current machine:
make agent

# OR, cross-compile an agent for another architecture:
make agent TARGET_ARCH=arm64 # accepted: amd64, arm64
```

The resulting binary will be in the current directory as `otel-profiling-agent`.
Expand All @@ -86,7 +90,7 @@ captured traces to the backend.
## Visualizing data locally

We created a desktop application called "devfiler" that allows visualizing the
profiling agent's output locally, making it very convenient for development use.
profiling agent's output locally, making it very convenient for development use.
devfiler spins up a local server that listens on `0.0.0.0:11000`.

![Screenshot of devfiler UI](./doc/devfiler.png)
Expand All @@ -104,7 +108,7 @@ The archive contains a build for each of the following platforms:
- Linux AppImage (x86_64)
- Linux AppImage (aarch64)

> [!NOTE]
> [!NOTE]
> devfiler is currently in an experimental preview stage.
### macOS
Expand Down

0 comments on commit cbc100c

Please sign in to comment.