readme: desc and build

This commit is contained in:
ardocrat 2024-04-14 17:54:30 +03:00
parent 3668c23052
commit 7d59d9e809

View file

@ -1,10 +1,15 @@
# <img height="22" src="https://github.com/ardocrat/grim/blob/master/app/src/main/ic_launcher-playstore.png?raw=true"> Grim <img height="20" src="https://github.com/mimblewimble/site/blob/master/assets/images/grin-logo.png?raw=true"> <img height="20" src="https://github.com/ardocrat/grim/blob/master/img/logo.png?raw=true"> # <img height="22" src="https://github.com/ardocrat/grim/blob/master/app/src/main/ic_launcher-playstore.png?raw=true"> Grim <img height="20" src="https://github.com/mimblewimble/site/blob/master/assets/images/grin-logo.png?raw=true"> <img height="20" src="https://github.com/ardocrat/grim/blob/master/img/logo.png?raw=true">
Cross-platform GUI for [Grin](https://github.com/mimblewimble/grin) on [Rust](https://stackoverflow.blog/2020/01/20/what-is-rust-and-why-is-it-so-popular/) with focus on usability and availability to be used by anyone, anywhere. Without censorship or restrictions. Cross-platform GUI for [GRiN ツ](https://github.com/mimblewimble/grin) in [Rust](https://github.com/rust-lang/rust)
for maximum compatibility with original [Mimblewimble](https://github.com/mimblewimble) implementation.
Initially supported platforms are Linux, Mac, Windows, limited Android and possible web support with help of [egui](https://github.com/emilk/egui) - GUI library in pure Rust.
Named by the character [Grim](http://harrypotter.wikia.com/wiki/Grim) - the shape of a large, black, menacing, spectral giant dog. Named by the character [Grim](http://harrypotter.wikia.com/wiki/Grim) - the shape of a large, black, menacing, spectral giant dog.
## Build instructions ## Build instructions
### Install Rust ### Install Rust
Follow instructions on [Windows](https://forge.rust-lang.org/infra/other-installation-methods.html).
`curl https://sh.rustup.rs -sSf | sh` `curl https://sh.rustup.rs -sSf | sh`
### Desktop ### Desktop