diff --git a/README.md b/README.md index 7b369c0fb..9a584dd51 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/docs/Building.md b/docs/Building.md index a14c8e3cc..fcea6c33b 100644 --- a/docs/Building.md +++ b/docs/Building.md @@ -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 @@ -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 +```