Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kernel-cyrus committed Feb 18, 2023
1 parent cb7a507 commit a4e1c3b
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

General kernel trace analysis framework

## Setup
## Setup Environment

Tracecat running environment is based on python and venv.

### For Linux & MacOS
### Setup on Linux or MacOS

Setup environment:

Expand Down Expand Up @@ -43,7 +43,7 @@ Then you can simply run by:
./venv/bin/deactivate
```

### For Windows
### Setup on Windows

Setup environment:

Expand Down Expand Up @@ -80,37 +80,37 @@ Then you can simply run by:
.\venv\Scripts\deactivate
```

## Build binary distribution
## Build Binary Distribution

You can also build tracecat into executables, so that it can simply run without any installations.

Build Windows release

```
.\build\build_win.bat (run on Windows)
.\build\build_win.bat (run on Windows)
```

Build Linux release

```
source ./build/build_linux.sh (run on Linux)
source ./build/build_linux.sh (run on Linux)
```

Build Mac release

```
source ./build/build_mac.sh (run on MacOS)
source ./build/build_mac.sh (run on MacOS)
```

Then you can get distribution package from:

```
./build/dist/tracecat.zip
./build/dist/tracecat.zip
```

## User Guide

See <docs/user_guide.txt>
See [docs/user_guide.txt](docs/user_guide.txt)

## Contact

Expand Down

0 comments on commit a4e1c3b

Please sign in to comment.