Skip to content

Commit d8e51e5

Browse files
committed
Rename project from Matrix-Rain to matrixfall
1 parent afb89f2 commit d8e51e5

4 files changed

Lines changed: 20 additions & 21 deletions

File tree

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[package]
2-
name = "matrix-rain"
2+
name = "matrixfall"
33
version = "0.3.0"
4-
description = "The matrix-rain effect in the terminal"
4+
description = "The matrixfall effect in the terminal"
55
authors = ["Shresht7"]
6-
repository = "https://github.com/Shresht7/matrix-rain"
6+
repository = "https://github.com/Shresht7/matrixfall"
77
license = "MIT"
8-
keywords = ["cli", "command-line-utilities", "matrix-rain"]
8+
keywords = ["cli", "command-line-utilities", "matrixfall"]
99
categories = ["command-line-utilities"]
1010
edition = "2024"
1111

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
# Matrix-Rain
2-
-------------
1+
# `matrixfall`
32

4-
The matrix-rain effect in the terminal.
3+
The matrixfall effect in the terminal.
54

65
![demo](./demo.gif)
76

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

2423
> [!NOTE]
2524
>
26-
> 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).
25+
> 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).
2726
2827
You can clone the repository and build the project:
2928

3029
```sh
31-
git clone https://github.com/Shresht7/matrix-rain.git
32-
cd matrix-rain
30+
git clone https://github.com/Shresht7/matrixfall.git
31+
cd matrixfall
3332
cargo build --release
3433
```
3534

@@ -39,44 +38,44 @@ To run the project, use the following command:
3938
cargo run --release
4039
```
4140

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

4443
```sh
45-
cargo install --path . --name matrix-rain
44+
cargo install --path . --name matrixfall
4645
```
4746

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

5049
---
5150

5251
## 📖 Usage Instructions
5352

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

5655
```sh
57-
matrix-rain [OPTIONS]
56+
matrixfall [OPTIONS]
5857
```
5958

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

6261
- To use the original Katakana symbols with the default settings:
6362
```sh
64-
matrix-rain
63+
matrixfall
6564
```
6665

6766
- To use binary symbols with a custom stream color and gradient:
6867
```sh
69-
matrix-rain --mode binary --stream-color 0,255,70 --stream-color-gradient-factor 0.5
68+
matrixfall --mode binary --stream-color 0,255,70 --stream-color-gradient-factor 0.5
7069
```
7170

7271
- To use ASCII characters with a higher frame rate and leave a trail:
7372
```sh
74-
matrix-rain --mode ASCII --fps 120 --leave-trail
73+
matrixfall --mode ASCII --fps 120 --leave-trail
7574
```
7675

7776
> [!TIP]
7877
>
79-
> You can combine multiple options to customize the matrix-rain effect to your liking.
78+
> You can combine multiple options to customize the matrixfall effect to your liking.
8079
8180
### Configuration Options
8281

src/main.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ fn run(config: &config::Config) -> std::io::Result<()> {
4848
// Setup the Matrix renderer
4949
matrix.setup(config, &mut stdout)?;
5050

51-
// Render the Matrix-Rain on screen
51+
// Render the matrixfall on screen
5252
loop {
5353
// Render each stream
5454
matrix.render(config, &mut stdout)?;

0 commit comments

Comments
 (0)