readme

readme.md

@@ -0,0 +1,26 @@
+# colcat
+
+Another lolcat clone. 
+
+This is probably the least feature-complete version of lolcat, (the `cat` clone that makes the output rainbow), but I wrote it anyway and probably won't do any more work on it.
+
+It breaks neofetch and I'm not sure why, I haven't looked deeply into ANSI escape codes. 
+
+Options:
+
+    colcat -l [rainbow width]
+
+Set how many characters it takes to change from red back to red.
+
+It is the norm for these programs to fuzz the rainbow a bit, and provide more options for the frequency and speed (actually come to think of it a sinusoidal would have been a simpler implementation than what I do), and animation options.
+
+I kind of like the look of the uniform rainbow though.
+
+![image showing square of repeating 'a's in rainbow colour](demo.png)
+
+## Similar Programs
+
+- [/jaseg/lolcat](https://github.com/jaseg/lolcat) (C)
+- [/busyloop/lolcat](https://github.com/busyloop/lolcat/) (Ruby)
+- [tehmaze/lolcat/](https://github.com/tehmaze/lolcat/) (Python)
+- [gkbrk](https://gist.github.com/gkbrk/34ed7df44ba1400f31eb73a3f238faa7) (x64 Assembly)