Skip to content

Commit

Permalink
Update readme and documentation with installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
SkwalExe committed Nov 9, 2024
1 parent c2e8c4c commit a616b42
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 93 deletions.
135 changes: 51 additions & 84 deletions Cargo.lock

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

27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,6 @@

<p align="center">💠 Terminal based fractal explorer, including Mandelbrot, Burning Ship, and Julia. 💠</p>

> [!WARNING]
> Rsfrac is in early development. It will become stable very soon.

# Documentation ✨

#### [**✨ ⟼ Please head over to our documentation for more information! ⟻ ✨**](https://rsfrac.skwal.net)
Expand All @@ -31,8 +27,27 @@

#### [**✨ ⟼ For up-to-date instructions, please head over to our documentation ⟻ ✨**](https://rsfrac.skwal.net)

> [!WARNING]
> This program is in early development, installation instructions will be added very soon!
From [crates.io](https://crates.io/):

```bash
cargo install rsfrac
```

From [the Github repo](https://github.com/SkwalExe/rsfrac):

```bash
cargo install --git https://github.com/SkwalExe/rsfrac
```

You can now start the application with the `rsfrac` command.

### `cargo` not found?

Cargo is the package manager for rust projects, it can be installed with:

```bash
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

# Features 🌟

Expand Down
Loading

0 comments on commit a616b42

Please sign in to comment.