Improve README and minor improvements

japonophile commented 3 years ago

This is an amazing project!!

I was able to run it in Ubuntu 20.04 (in VirtualBox on OS X), but I found it much easier to run it in Docker (like done by Travis), so I added a section in the README to explain it (hoping it's easier for newcomers).

Now I realize it might be better to add this section in https://github.com/mame/quine-relay/wiki/Installation Let me know what you think.

Other minor improvements:

add the .curry directory to .gitignore
take a backup of QR.c when running Lisaac, because it causes the SHA1SUM to be wrong for QC.c (overwritten by Lisaac)
add quotes to the $(CI) environment variable check, as it causes the condition to be invalid when the variable is not defined.

japonophile commented 3 years ago

Oops, I just noticed README.md is generated by src/README.md.gen.rb, so if modifying it, I'd rather update the generator. Let me know if this is appropriate and I'll make the change.

mame commented 3 years ago

Great, thanks!

mame / quine-relay

Improve README and minor improvements #104