README and LICENSE stuff

This commit is contained in:
PoroCYon 2019-05-07 14:03:08 +02:00
parent ddf6afc643
commit 57c2bf06fd
3 changed files with 34 additions and 26 deletions

View File

@ -1,26 +0,0 @@
# 4klang on Linux
Small template code to get 4klang running on Linux :)
Quickly hacked together by PoroCYon.
Hugs to Alkama and noby for providing test tracks!
## How to use
### Requirements
* A C compiler, make, sed, awk
* nasm or yasm
### Usage
1. Put the exported 4klang files in the `mus` folder (`4klang.asm`,
`4klang.inc` and `4klang.h`).
2. Run `make`
3. Run `bin/runner`
## License
[WTFPL](/LICENSE).

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# Linux templates for PC intro synths
Small template code to get 4klang and V2 running on Linux :)
Quickly hacked together by PoroCYon.
Hugs to Alkama and noby for providing 4klang test tracks!
## How to use
### Requirements
* A C compiler, make, sed, awk
* nasm or yasm
### Usage
#### 4klang
1. Put the exported 4klang files in the `mus` folder (`4klang.asm`,
`4klang.inc` and `4klang.h`).
2. Run `make`
3. Run `bin/runner`
#### V2
1. Put the exported `.v2m` files in the `mus` folder.
2. Run `make`
3. Run `bin/lplayer-<songname> | aplay -c2 -r44100 -fFLOAT_LE`
## License
[WTFPL](/LICENSE).