diff --git a/README.md b/README.md new file mode 100644 index 0000000..4bb323b --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# README + +## About +roflcat is a C++ rewrite of [lolcat][1] which runs much faster and supports all the options of GNU cat. I am not going to support the animation options of lolcat (--animate, --duration, --speed) because there is no real purpose to them. +Currently I can only confirm it runs on a linux system and I have no desire to expand to supporting anything else at this time. + +To keep compatability with both GNU cat and lolcat, I wanted all command line options from both to either be implemented or ignored. However there are a few conflicts between the two, namely -s -t and -v. For these I will be implementing the GNU cat functionality. + +Current version is 0.1a as of writing this, so if the version is much newer, remind me to update this readme :) +![alt text](https://i.postimg.cc/1tYmJzxd/roflcat-usage.png "Screenshot of --help output") + +## Building +There is no release right now. There is only the debug build which will produce an executable called 'tester'. +To build just run `make`. + +## Installing +I would not recommend installing at this time. There is no install target in the makefile. + +[1]: https://github.com/busyloop/lolcat