docs: Add README.md
This commit is contained in:
parent
79c1f4fd48
commit
88bc2a8706
1 changed files with 73 additions and 0 deletions
73
README.md
Normal file
73
README.md
Normal file
|
@ -0,0 +1,73 @@
|
|||
<p align="center">
|
||||
<h1 align="center"><img src="https://myimgs.org/storage/images/2275/jaaj-rs_logo.png"></h1>
|
||||
<h6 align="center">
|
||||
<a href="https://crates.io/crates/jaaj-rs">
|
||||
<img src="https://img.shields.io/crates/v/jaaj-rs.svg" align="top">
|
||||
</a>
|
||||
</h6>
|
||||
|
||||
<div align="center">
|
||||
A minimal, memory-safe ✨ and blazingly 🔥 fast 🚀 JaaJ implementation written in Rust
|
||||
</div>
|
||||
</p>
|
||||
|
||||
Built using [rulet](https://crates.io/crates/rulet) and FIGlet fonts hosted by [PLiG](http://www.figlet.org/).
|
||||
|
||||
## Features
|
||||
|
||||
- 🎨 150+ fonts
|
||||
- 😼 Terminal colors
|
||||
- ⚡ Compile time JaaJ rendering
|
||||
- 🦀 Rust
|
||||
- 💡 Easy to use
|
||||
- 🗿 JaaJ
|
||||
- 🤯 And much more!
|
||||
|
||||
## Installation
|
||||
|
||||
### Cargo
|
||||
|
||||
```sh
|
||||
cargo install jaaj-rs
|
||||
# With terminal colors support
|
||||
cargo install --features lolcat jaaj-rs
|
||||
```
|
||||
|
||||
### Nix
|
||||
|
||||
Add [jaaj-rs](https://www.youtube.com/watch?v=8IKMzm7bb0o) to your Nix flakes !
|
||||
|
||||
```nix
|
||||
{
|
||||
description = "Jaajesque !";
|
||||
|
||||
inputs = {
|
||||
jaaj-rs = {
|
||||
url = "git+https://git.ahur.ac/Jaaj-San/jaaj-rs";
|
||||
inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
};
|
||||
}
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```sh
|
||||
alias jaaj="jaaj-rs" # For enhanced ergonomics
|
||||
jaaj
|
||||
```
|
||||
|
||||
### Nix
|
||||
|
||||
```nix
|
||||
{inputs, pkgs, ...}: {
|
||||
|
||||
environment.systemPackages = [
|
||||
# Minimal version
|
||||
inputs.jaaj-rs.packages.${pkgs.system}.default
|
||||
# Colored version
|
||||
inputs.jaaj-rs.packages.${pkgs.system}.lolcat
|
||||
];
|
||||
|
||||
}
|
||||
```
|
Loading…
Add table
Reference in a new issue