Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "matrix-rain"
name = "matrixfall"
version = "0.3.0"
description = "The matrix-rain effect in the terminal"
description = "The matrixfall effect in the terminal"
authors = ["Shresht7"]
repository = "https://github.com/Shresht7/matrix-rain"
repository = "https://github.com/Shresht7/matrixfall"
license = "MIT"
keywords = ["cli", "command-line-utilities", "matrix-rain"]
keywords = ["cli", "command-line-utilities", "matrixfall"]
categories = ["command-line-utilities"]
edition = "2024"

Expand Down
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Matrix-Rain
-------------
# `matrixfall`

The matrix-rain effect in the terminal.
The matrixfall effect in the terminal.

![demo](./demo.gif)

Expand All @@ -23,13 +22,13 @@ The matrix-rain effect in the terminal.

> [!NOTE]
>
> To install and run Matrix-Rain, you will need to have Rust and Cargo installed on your system. You can install Rust and Cargo by following the instructions at [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install).
> To install and run matrixfall, you will need to have Rust and Cargo installed on your system. You can install Rust and Cargo by following the instructions at [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install).

You can clone the repository and build the project:

```sh
git clone https://github.com/Shresht7/matrix-rain.git
cd matrix-rain
git clone https://github.com/Shresht7/matrixfall.git
cd matrixfall
cargo build --release
```

Expand All @@ -39,44 +38,44 @@ To run the project, use the following command:
cargo run --release
```

Or **alternatively**, you can also install `Matrix-Rain` using `cargo install` and add it to your `$PATH` variable for easy access:
Or **alternatively**, you can also install `matrixfall` using `cargo install` and add it to your `$PATH` variable for easy access:

```sh
cargo install --path . --name matrix-rain
cargo install --path . --name matrixfall
```

After installation, you can run Matrix-Rain from anywhere by adding the Cargo bin directory to your `$PATH` variable.
After installation, you can run matrixfall from anywhere by adding the Cargo bin directory to your `$PATH` variable.

---

## 📖 Usage Instructions

To use Matrix-Rain, you can run the project with the following command:
To use matrixfall, you can run the project with the following command:

```sh
matrix-rain [OPTIONS]
matrixfall [OPTIONS]
```

Here are some examples of how to use the different configuration options:

- To use the original Katakana symbols with the default settings:
```sh
matrix-rain
matrixfall
```

- To use binary symbols with a custom stream color and gradient:
```sh
matrix-rain --mode binary --stream-color 0,255,70 --stream-color-gradient-factor 0.5
matrixfall --mode binary --stream-color 0,255,70 --stream-color-gradient-factor 0.5
```

- To use ASCII characters with a higher frame rate and leave a trail:
```sh
matrix-rain --mode ASCII --fps 120 --leave-trail
matrixfall --mode ASCII --fps 120 --leave-trail
```

> [!TIP]
>
> You can combine multiple options to customize the matrix-rain effect to your liking.
> You can combine multiple options to customize the matrixfall effect to your liking.

### Configuration Options

Expand Down
2 changes: 1 addition & 1 deletion src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ fn run(config: &config::Config) -> std::io::Result<()> {
// Setup the Matrix renderer
matrix.setup(config, &mut stdout)?;

// Render the Matrix-Rain on screen
// Render the matrixfall on screen
loop {
// Render each stream
matrix.render(config, &mut stdout)?;
Expand Down