Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sectordistrict authored Nov 4, 2024
1 parent 0971db1 commit 89e71a2
Showing 1 changed file with 23 additions and 19 deletions.
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,35 +43,45 @@ Intentrace follows a similar working methodology to the one employed by the [Uni



## Building from source
## Installation

### Prerequisites
### Build from source

Prerequisites:

* Latest stable version of [Rust](https://www.rust-lang.org/tools/install) and Cargo.

#### Supported architecture

intentrace currently only supports `x86-64`, given that the program is currently in beta, PRs for cross compatibility will unfortunately not be accepted until the program is stable enough.
Build and run intentrace:

### Build
```
git clone https://github.com/sectordistrict/intentrace.git
cd intentrace`
cargo build --release
```

#### Use the following command to build and run intentrace:

`git clone https://github.com/sectordistrict/intentrace.git`
### Install from crates.io:

`cd intentrace`
```
cargo install intentrace
```

`cargo build --release`

## Project status

#### Use the following command to install from crates.io:
intentrace is currently in beta, currently multi-threaded programs are a hit and miss.

`cargo install intentrace`
intentrace was originally intended to be a 2 window TUI, where a top panel shows a normal stream of syscalls, and a bottom panel containing metadata and explanation, however this was abandoned in favor of the current scheme.

#### Supported architecture

## Project status
intentrace currently only supports `x86-64`, given that the program is currently in beta, PRs for cross compatibility will unfortunately not be accepted until the program is stable enough.

intentrace is currently in beta, currently multi-threaded programs are a hit and miss.

## Contributing

Support intentrace by contributing issues and PRs, don't feel discouraged from filing issues or creating PRs. Reading the source is a great way to learn how linux works.

Feel free to file issues and open Pull Requests.
Issues and PRs can contain and involve:
Expand All @@ -80,9 +90,3 @@ Issues and PRs can contain and involve:
- suggestions for fixes.
- etc.. there are no rules, feel free to contribute as you see fit.

intentrace was originally intended to be a 2 window TUI, where a top panel shows a normal stream of syscalls, and a bottom panel containing metadata and explanation, however this was abandoned in favor of the current scheme.


## Contributing

Support intentrace by contributing issues and PRs, don't feel discouraged from filing issues or creating PRs. Reading the source is a great way to learn how linux works.

0 comments on commit 89e71a2

Please sign in to comment.