Skip to content

Commit

Permalink
docs: development guide introduction added
Browse files Browse the repository at this point in the history
  • Loading branch information
sdvendramini committed Feb 19, 2025
1 parent 27be62d commit 33acaa3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,11 @@ To install the Wazuh Agent, follow the steps below:
git clone https://github.com/wazuh/wazuh-agent.git
cd wazuh-agent
```
2. Build and install the agent: see [build-sources.md](docs/dev/build-sources.md).
2. Use one of the following options:

- [Build from sources](docs/dev/build-sources.md)
- [Build packages](docs/dev/build-packages.md)
- [Build a Docker container image](docs/dev/build-image.md)

For more detailed installation instructions, please refer to the Wazuh documentation.

Expand Down
16 changes: 16 additions & 0 deletions docs/dev/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Wazuh Agent Development Guide

This guide provides comprehensive, step-by-step instructions for building, testing, and packaging the Wazuh Agent.
Whether you’re compiling the source code, generating platform-specific packages, or creating Docker container images,
you’ll find all the necessary information here to streamline your development process.

The guide is organized into the following sections:

- **Setup Environment**: Guide for configuring the development environment ([setup.md](setup.md))
- **Build Packages**: Step-by-step guide for generating installation packages for various platforms ([build-packages.md](build-packages.md))
- **Build Image**: Guidelines for building a Docker container image for the agent ([build-image.md](build-image.md))
- **Build from Sources**: Detailed instructions for compiling the agent directly from its source code ([build-sources.md](build-sources.md))
- **Run from Sources**: Instructions for running the agent directly from the source code ([run-agent.md](run-agent.md))
- **Run Tests**: Procedures to execute tests ([run-tests.md](run-tests.md))

Follow the instructions in each section to set up your development environment and efficiently build the Wazuh Agent.

0 comments on commit 33acaa3

Please sign in to comment.