Skip to content

Commit

Permalink
Update readme for building sysinspect
Browse files Browse the repository at this point in the history
  • Loading branch information
isbm committed Nov 20, 2024
1 parent 9dde809 commit 083d397
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@

Sysinspect is an engine of Anomaly Detection and Root Cause Analysis.
This engine is indented to perform anomaly detection and root cause analysis on any system.
It is using Model Description as a source of knowledge and a collection of modules with telemetry data in order to perform various testing scenarios.
It is using Model Description as a source of knowledge and a
collection of modules with telemetry data in order to perform various
testing scenarios.

## Use Case

Primarily this is an experimental work for Anomaly Detection (AD) and Root Cause Analysis (RCA).

## Bonus Use Case

Configuration management. As Sysinspect can get the information, it also can set the information. It is a matter of modules.
Configuration management. As Sysinspect can get the information, it
also can set the information. It is a matter of modules.
This workflow works very similar to Ansible style.

## Documentation
Expand All @@ -26,9 +29,22 @@ Complete documentation can be found here: [https://sysinspect.readthedocs.io/en/

## Building & Requirements

At this moment, Rust 1.81 toolchain is required. Maybe earlier versions also work. 😉
To build Sysinspect, **do not** use `cargo` directly, but use GNU Make. Building release
is as simple as that:
At this moment, Rust 1.81 toolchain is required. Maybe earlier
versions also work. 😉

### Dependencies

Your system should have the following packages (Ubuntu/Debian):

- pkg-config
- libssl-dev

Or equivalent names in your Linux distribution.

### Building

To build Sysinspect, **do not** use `cargo` directly, but use GNU
Make. Building release xis as simple as that:

make <ENTER>

Expand Down

0 comments on commit 083d397

Please sign in to comment.