summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3f57dd6..4f19893 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,32 @@
# myal - My Anime Library
-My Anime Library is program to manage an anime watchlist, written in C.
+My Anime Library is cli-tool to manage an anime watchlist, written in C.
I used to track which anime I have watched and what episode I'm on by writing in
a text file, which got annoying after a while.
-This is why I created a simple program to quickly search and change a csv-file.
+This is why I created a simple program to quickly search and change a
+csv file.
+
Is it a complete overkill to write this in C? Yes
Could this have been a simple bash script? Definitely
-But I was bored and writing C is fun. \ No newline at end of file
+
+But why not?
+
+This cli-tool works with csv files in the format
+
+name,episode
+
+For example:
+
+Samurai Champloo,14
+Bakemonogatari,done
+Steins; Gate,1
+
+and so on.
+You need to set your filepath in the main.c, but everything else should work
+out of the box.
+The Makefile uses clang, but you can change it to gcc in the second line. Or
+you could simply do
+
+```
+gcc -o myal main.c
+``` \ No newline at end of file