Skip to content

Commit

Permalink
Fix link in README and minor edits. (#220)
Browse files Browse the repository at this point in the history
  • Loading branch information
kirkrodrigues authored Jan 7, 2024
1 parent 149ebd1 commit 2ae14de
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ searching the compressed logs without decompression. To learn more about it, you
# Getting Started

You can download a release from the [releases](https://github.com/y-scope/clp/releases) page, or
you can build the [latest](docs/BUILDING.md).
you can build the [latest](docs/Building.md).

For some logs you can use to test CLP, check out our open-source
[datasets](docs/Datasets.md).
Expand Down
34 changes: 17 additions & 17 deletions docs/Building.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ prebuilt version instead, check out the [releases](https://github.com/y-scope/cl

# Setup

* Download CLP core's source dependencies:
Download CLP core's source dependencies:

```shell
components/core/tools/scripts/deps-download/download-all.sh
```
```shell
components/core/tools/scripts/deps-download/download-all.sh
```

* Install CLP core's dependencies
Install CLP core's dependencies

```shell
components/core/tools/ubuntu-focal/install-all.sh
```
```shell
components/core/tools/ubuntu-focal/install-all.sh
```

# Build

Expand All @@ -35,18 +35,18 @@ To build the package as a tar ball, run;
task package-tar
```

The built package will be output as a tar file in the `build` directory.
The built tar will be output in the `build` directory.

# Cleanup

* To clean up the package, run:
To clean up the package, run:

```shell
task clean-package
```
```shell
task clean-package
```

* To clean up all build artifacts, run:
To clean up all build artifacts, run:

```shell
task clean
```
```shell
task clean
```

0 comments on commit 2ae14de

Please sign in to comment.