From 8fcbdd2a170c5b0aebc994659cca2ddcf02a6ae1 Mon Sep 17 00:00:00 2001 From: Rudra Gupta Date: Thu, 15 Aug 2024 17:28:51 -0400 Subject: [PATCH] Adds build from source installation instruction (#21) Instructions for users to build privateer from source --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index b192223..465a8b7 100644 --- a/README.md +++ b/README.md @@ -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.