Skip to content

Commit

Permalink
docs: reorganized README
Browse files Browse the repository at this point in the history
Signed-off-by: Alessio Greggi <ale_grey_91@hotmail.it>
  • Loading branch information
alegrey91 committed Apr 19, 2024
1 parent 97abf72 commit a0b6462
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,24 +44,26 @@ These are the syscalls that have been executed by the traced function!

## Installation

### Build
To install `harpoon` you currently have 2 options:

### Download

Once you have all the needed tools to run `harpoon`, you can build it locally with:
You can easily download the latest release using the installation script:

```sh
make build
curl -s https://raw.githubusercontent.com/alegrey91/harpoon/main/install | sudo sh
```

After the build is completed, you can find the executable under the `bin/` directory.

### Download
### Build

Alternatively, you can easily download the latest release using the one liner:
Or you can build `harpoon` manually by using the following command:

```sh
curl -s https://raw.githubusercontent.com/alegrey91/harpoon/main/install | sudo sh
make build
```

After the build is completed, you can find the executable under the `bin/` directory.

## Debugging

In case you want to run the application locally, I've provided the [`.vscode/launch.json`](.vscode/launch.json) file to easily debug the application with `root` privileges in `vscode`. Just replace the parameters marked with `<>`.
Expand Down

0 comments on commit a0b6462

Please sign in to comment.