mirror of
https://github.com/kiedtl/fire.git
synced 2024-11-16 04:56:38 +00:00
README: edit headers
This commit is contained in:
parent
3210c4d5ec
commit
cfe514bea0
14
README.md
14
README.md
@ -2,19 +2,19 @@
|
|||||||
|
|
||||||
> The ancient DOOM fire animation in the terminal!
|
> The ancient DOOM fire animation in the terminal!
|
||||||
|
|
||||||
### what?
|
## what?
|
||||||
`fire` is a remake of the PSX DOOM fire animation in the terminal,
|
`fire` is a remake of the PSX DOOM fire animation in the terminal,
|
||||||
as seen in the [ly](https://github.com/cylgom/ly) display manager.
|
as seen in the [ly](https://github.com/cylgom/ly) display manager.
|
||||||
It's described nicely by Fabien Sanglard on his
|
It's described nicely by Fabien Sanglard on his
|
||||||
[blog](https://fabiensanglard.net/doom_fire_psx/index.html).
|
[blog](https://fabiensanglard.net/doom_fire_psx/index.html).
|
||||||
|
|
||||||
### where?
|
## where?
|
||||||
#### supported platforms
|
### supported platforms
|
||||||
- Linux (musl/glibc) (*tested and supported*)
|
- Linux (musl/glibc) (*tested and supported*)
|
||||||
- Windows (*should work, but not tested*)
|
- Windows (*should work, but not tested*)
|
||||||
- (Dragonfly|Net|Free|Open)BSD: (*not tested, might work*)
|
- (Dragonfly|Net|Free|Open)BSD: (*not tested, might work*)
|
||||||
|
|
||||||
#### building from source
|
### building from source
|
||||||
You will need:
|
You will need:
|
||||||
- `git`
|
- `git`
|
||||||
- a c99 compiler (gcc or clang)
|
- a c99 compiler (gcc or clang)
|
||||||
@ -40,7 +40,7 @@ Uninstall, if you wish:
|
|||||||
# rm -f /usr/bin/fire
|
# rm -f /usr/bin/fire
|
||||||
```
|
```
|
||||||
|
|
||||||
### how?
|
## how?
|
||||||
simply run `./fire` (or `fire`, if you installed) and enjoy.
|
simply run `./fire` (or `fire`, if you installed) and enjoy.
|
||||||
```
|
```
|
||||||
$ fire
|
$ fire
|
||||||
@ -49,11 +49,11 @@ $ fire
|
|||||||
### why?
|
### why?
|
||||||
I'm bored
|
I'm bored
|
||||||
|
|
||||||
### credits
|
## credits
|
||||||
Thanks to @cylgom, for inspiring me to make this project.
|
Thanks to @cylgom, for inspiring me to make this project.
|
||||||
More thanks to @cylgom, from whose repositories I sto^Hborrowed a lot
|
More thanks to @cylgom, from whose repositories I sto^Hborrowed a lot
|
||||||
of stuff :)
|
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 LICENSE.md file
|
||||||
for more information.
|
for more information.
|
||||||
|
Loading…
Reference in New Issue
Block a user