github/kubescape
1
0
Fork 0
mirror of https://github.com/kubescape/kubescape.git synced 2026-04-15 06:58:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add minimum build instructions

Hollow Man
2023-05-18 13:53:45 +03:00
parent 38f68cbfae
commit dd73be7860
1 changed files with 32 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Building.md
+32 -14
@@ -3,6 +3,7 @@
1. Setup [Golang compiling environment](https://go.dev/doc/install) (Golang ≥ 1.19)
2. Setup [Git](https://git-scm.com/downloads)
3. Clone this repository
```bash
git clone https://github.com/kubescape/kubescape
cd kubescape
@@ -10,14 +11,33 @@ cd kubescape
## Build on Windows
### Minimum build
1. Install MSYS2 _(needed only for the first time)_
```
build.bat install
```
2. Build kubescape
```
go build -tags=static .
```
### With git enabled
> **Note**
> For performance reasons it's better to build with this dependency when **scanning git repos**.
1. Install MSYS2 & build libgit _(needed only for the first time)_
> **Note**
> You can install MSYS2 separately by running `build.bat install` and build libgit2 separately by running `build.bat build`
```
build.bat all
```
> **Note**
> You can install MSYS2 separately by running `build.bat install` and build libgit2 separately by running `build.bat build`
2. Build kubescape
@@ -25,20 +45,24 @@ cd kubescape
make build
```
OR
## Build on Linux/MacOS
### Minimum build
1. Build kubescape
```
go build -tags=static .
```
## Build on Linux/MacOS
### With git enabled
1. Install libgit2 dependency _(needed only for the first time)_
> **Note**:
> `cmake` and `pkg-config` is required to build libgit2. You can install it by running `sudo apt-get install cmake pkg-config` (Linux) or `brew install cmake pkg-config` (macOS).
> **Note**
> 1. For performance reasons it's better to build with this dependency when **scanning git repos**.
> 2. `cmake` and `pkg-config` is required to build libgit2. You can install it by running `sudo apt-get install cmake pkg-config` (Linux) or `brew install cmake pkg-config` (macOS).
```bash
```
make libgit2
```
@@ -48,12 +72,6 @@ cd kubescape
make build
```
OR
```
go build -tags=static .
```
3. Test
```