summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoryuzu-eva <stevenhu@web.de>2024-12-19 17:58:21 +0100
committeryuzu-eva <stevenhu@web.de>2024-12-19 17:58:21 +0100
commit99425e48e1c53595a9ff4d66c819c6d46c6d2bdc (patch)
tree3f01ddf49bfa38c99dbeb8d492475ffbf3a6ded2 /README.md
parentb411238e832803b037206ddc3355e6795a7ac659 (diff)
added help flag -h
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index 9ec3359..dd9b0e8 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# myal - My Anime Library
-My Anime Library is cli-tool to manage an anime watchlist, written in C.
+My Anime Library is a cli-tool written in C to manage an anime watchlist.
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
@@ -9,24 +9,25 @@ csv file.
Is it a complete overkill to write this in C? Yes
Could this have been a simple bash script? Definitely
-But why not?
+But why not? I wanted some practice with C, so if you see any glaring errors or
+unsafe code feel free to point it out and roast me.
This cli-tool works with csv files in the format
name,episode
-For example:
+For example:
Samurai Champloo,14
Bakemonogatari,done
Steins; Gate,1
and so on. The episode is actually stored as a string, so you can put "done" or
-"abandoned" or anything else you want in there. Allows for a maximum length of
-11.
+"abandoned" or anything else you want in there. The string allows for a maximum
+length of 11.
-You need to set your filepath in the main.c, but everything else should work
-out of the box.
+You need to set the filepath to you csv 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