fire/README.md

67 lines
1.3 KiB
Markdown
Raw Normal View History

2019-12-14 01:55:45 +00:00
![](https://github.com/lptstr/lptstr-images/blob/master/proj/fire/scrot.jpg?raw=true)
2019-12-13 14:47:49 +00:00
# fire
> The ancient DOOM fire animation in the terminal!
2019-12-13 14:50:39 +00:00
## what?
2019-12-13 14:47:49 +00:00
`fire` is a remake of the PSX DOOM fire animation in the terminal,
2020-09-17 11:41:51 +00:00
as seen in the [ly](https://github.com/nullgemm/ly) display manager.
2019-12-13 14:47:49 +00:00
It's described nicely by Fabien Sanglard on his
[blog](https://fabiensanglard.net/doom_fire_psx/index.html).
2019-12-13 14:50:39 +00:00
## where?
### supported platforms
2019-12-13 14:47:49 +00:00
- Linux (musl/glibc) (*tested and supported*)
- Windows (*should work, but not tested*)
- (Dragonfly|Net|Free|Open)BSD: (*not tested, might work*)
2019-12-13 14:50:39 +00:00
### building from source
2019-12-13 14:47:49 +00:00
You will need:
2019-12-14 21:25:12 +00:00
- `git` or `wget`
2019-12-13 14:47:49 +00:00
- a c99 compiler (gcc or clang)
2020-03-10 02:25:39 +00:00
- `gmake` (`bmake` is untested, but should work.)
2019-12-13 14:47:49 +00:00
2019-12-14 21:25:12 +00:00
Retrieve the source:
2019-12-13 14:47:49 +00:00
```
2019-12-14 21:25:12 +00:00
$ # via git:
2019-12-13 14:47:49 +00:00
$ git --recurse clone https://github.com/lptstr/fire
2019-12-14 21:25:12 +00:00
$
$ # via wget:
$ wget https://github.com/lptstr/fire/archive/master.tar.gz
$ tar xvf master.tar.gz
2019-12-13 14:47:49 +00:00
```
Build:
```
$ make
```
and install:
```
# make install
```
Uninstall, if you wish:
```
2019-12-14 21:25:12 +00:00
# make uninstall
2019-12-13 14:47:49 +00:00
```
2019-12-13 14:50:39 +00:00
## how?
2020-09-17 11:41:51 +00:00
simply run `fire`:
2019-12-13 14:47:49 +00:00
```
2020-09-17 11:41:51 +00:00
$ ./fire
2019-12-13 14:47:49 +00:00
```
### why?
I'm bored
2019-12-13 14:50:39 +00:00
## credits
2020-09-17 11:41:51 +00:00
- Thanks to @nullgemm, for inspiring me to make this project.
- More thanks to @nullgemm, from whose repositories I sto^Hborrowed a lot
2019-12-13 14:47:49 +00:00
of stuff :)
2019-12-13 14:50:39 +00:00
## license
2019-12-13 14:47:49 +00:00
This project is licensed under the MIT license. View the LICENSE.md file
for more information.