Skip to content

Commit

Permalink
docs: move installation guide to INSTALL.md
Browse files Browse the repository at this point in the history
I only added INSTALL.md but forget to update README.md
  • Loading branch information
kxxt committed Sep 18, 2024
1 parent eeea142 commit b9a23fc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 32 deletions.
18 changes: 2 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ tracexec helps you to figure out what and how programs get executed when you exe
It's useful for debugging build systems, understanding what shell scripts actually do, figuring out what programs
does a proprietary software run, etc.

- [Installation Guide](INSTALL.md)

## Showcases

### TUI mode with pseudo terminal
Expand Down Expand Up @@ -110,22 +112,6 @@ $ tracexec log --show-interpreter --show-cwd -- makepkg -f

[![asciicast](https://asciinema.org/a/7jDtrlNRx5XUnDXeDBsMRj09p.svg)](https://asciinema.org/a/7jDtrlNRx5XUnDXeDBsMRj09p)

## Installation

### From source

Via cargo:

```bash
cargo install tracexec --bin tracexec
```

Arch Linux users can also install from the official repositories via `pacman -S tracexec`.

### Binary

You can download the binary from the [release page](https://github.com/kxxt/tracexec/releases)

## Usage

General CLI help:
Expand Down
18 changes: 2 additions & 16 deletions README.template.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ tracexec helps you to figure out what and how programs get executed when you exe
It's useful for debugging build systems, understanding what shell scripts actually do, figuring out what programs
does a proprietary software run, etc.

- [Installation Guide](INSTALL.md)

## Showcases

### TUI mode with pseudo terminal
Expand Down Expand Up @@ -110,22 +112,6 @@ $ tracexec log --show-interpreter --show-cwd -- makepkg -f

[![asciicast](https://asciinema.org/a/7jDtrlNRx5XUnDXeDBsMRj09p.svg)](https://asciinema.org/a/7jDtrlNRx5XUnDXeDBsMRj09p)

## Installation

### From source

Via cargo:

```bash
cargo install tracexec --bin tracexec
```

Arch Linux users can also install from the official repositories via `pacman -S tracexec`.

### Binary

You can download the binary from the [release page](https://github.com/kxxt/tracexec/releases)

## Usage

General CLI help:
Expand Down

0 comments on commit b9a23fc

Please sign in to comment.