Skip to content

Commit

Permalink
Adds build from source installation instruction (#21)
Browse files Browse the repository at this point in the history
Instructions for users to build privateer from source
  • Loading branch information
grudra7714 authored Aug 15, 2024
1 parent dd882cf commit 8fcbdd2
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,24 @@ Privateer empowers you to ensure the security, compliance, and integrity of your
1. **Download Privateer**: Obtain the latest release of Privateer from the [GitHub repository](https://github.com/privateerproj/privateer/releases).
1. **Install Raids**: Choose the raid(s) you wish to use from the same release on GitHub. Install them to your preferred `binaries-path`. By default, this is `$HOME/privateer/bin`, but you can customize it in your configuration or via `--binaries-path`.

#### Build Privateer from Source

To build privateer, please follow these steps below:

1. **Clone the Repository**

```sh
git clone https://github.com/privateerproj/privateer.git
cd privateer

2. **Installting Dependencies**
```sh
go mod tidy
3. **Building Privateer**
```sh
make release

### Configuration

1. **Create a Configuration File**: Craft a configuration file (e.g., `config.yml`) that specifies the raids you intend to run and any necessary configuration options. Include secrets and settings required by the raid. Refer to the specific raid's documentation for precise details.
Expand Down

0 comments on commit 8fcbdd2

Please sign in to comment.