From f090ed44704fbeedee73c8b2dea780285c14e776 Mon Sep 17 00:00:00 2001 From: Vito Caputo Date: Sun, 19 Apr 2020 17:02:32 -0700 Subject: README: add a rudimentary README file --- README | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 0000000..1014449 --- /dev/null +++ b/README @@ -0,0 +1,30 @@ +Building from source: + +You've probably already done this, but first clone the repo: +`git clone git://git.pengaru.com/sars` + +There are a few submodules which must be initialized recursively +before sars will be able to compile, this does the trick: + +`git submodule update --init --recursive --remote` + +Now it's fairly run of the mill autotools: + +``` +$ mkdir build +$ ./bootstrap +$ cd build +$ ../configure +$ make +$ ./src/sars +``` + +The program assumes there will be assets found under the assets/ +folder relative to the current working directory. + +These are some .ogg files and .wav files, and they're not checked +into the git repo. + +This README will be updated in the future with links to where the +production .zip has been uploaded on the wider internet, from those +archies you can grab the sound assets if desired. -- cgit v1.2.3