mirrors/fire
1
Fork 0
mirror of https://github.com/kiedtl/fire.git synced 2024-11-15 20:46:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

README.md: update

Browse Source
This commit is contained in:
Kiëd Llaentenn 2020-09-17 19:03:57 +00:00
parent 12c84f877a
commit 37caaa70a3
1 changed files with 13 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -18,18 +18,14 @@ It's described nicely by Fabien Sanglard on his
### building from source ### building from source
You will need: You will need:
- `git` or `wget` - `git`
- a c99 compiler (gcc or clang) - a c99 compiler (gcc or clang)
- `gmake` (`bmake` is untested, but should work.) - `gmake` (`bmake` is untested, but might work.)
Retrieve the source: Retrieve the source:
``` ```
$ # via git: $ # via git:
$ git --recurse clone https://github.com/lptstr/fire $ git clone https://github.com/lptstr/fire --recurse
$
$ # via wget:
$ wget https://github.com/lptstr/fire/archive/master.tar.gz
$ tar xvf master.tar.gz
``` ```
Build: Build:
@ -48,19 +44,22 @@ Uninstall, if you wish:
``` ```
## how? ## how?
simply run `fire`:
``` ```
$ ./fire $ fire # no args for default animation
$ fire -h # help message
$ fire -Rw0 -f100 # matrix effect
$ fire -l2 -w2 # small fire with wind blowing east
$ fire -Rw0 -f1000000 # california animation
$ fire -t -l2 -f3 # truecolor!
``` ```
### why? ### why?
I'm bored I'm bored
## credits ## credits
- Thanks to @nullgemm, for inspiring me to make this project. This code was originally based on [`ly`](https://github.com/nullgemm/ly)'s
- More thanks to @nullgemm, from whose repositories I sto^Hborrowed a lot animation code.
of stuff :)
## license ## license
This project is licensed under the MIT license. View the LICENSE.md file This project is licensed under the MIT license. View the [COPYING](COPYING)
for more information. file for more information.