From 89e71a2beb94cbc24d42bb22a897941ba835b71e Mon Sep 17 00:00:00 2001 From: sectordistrict <157201659+sectordistrict@users.noreply.github.com> Date: Mon, 4 Nov 2024 18:45:38 +0200 Subject: [PATCH] Update README.md --- README.md | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index c7eb44e..06629ed 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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.