From 7cd7876202746fded86d770fb77aea0f55b814d8 Mon Sep 17 00:00:00 2001
From: yuzu-eva <cafebabe@disroot.org>
Date: Tue, 25 Mar 2025 16:15:25 +0100
Subject: added db-setup script; fixed makefile

---
 README.md | 37 +++++++++++++++++++------------------
 1 file changed, 19 insertions(+), 18 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 3cc04ad..65914da 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,34 @@
 # myal - My Anime Library
 
-My Anime Library is a cli-tool written in C to manage an anime watchlist.  
+My Anime Library is a cli-tool written in C to manage an anime and manga list.  
 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 this tool to keep anime and manga organized in a sqlite3
+database.  
 
 Is it a complete overkill to write this in C? Yes  
-Could this have been a simple bash script? Definitely  
-
 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,status  
+unsafe code feel free to point it out and roast me.  
 
-For example:
+You need a database with tables `anime` and `manga`. Attached in this repo
+is a setup script for the database. Simply execute
+```
+sqlite3 <db-setup.sql
+```
 
-Samurai Champloo,14,watching  
-Bakemonogatari,0,done  
-Steins; Gate,1,watching  
+This will create the following tables:  
+anime(ID integer pk, NAME text, EPISODE text, STATUS text)  
+manga(ID integer pk, NAME text, CHAPTER text, STATUS text)  
 
-and so on. If I'm done watching a series, the episode is set to '0'.  
+Chapters and episodes are stored as text, because sometimes the chapter isn't
+just a number but rather in the form "Volume 6 Chapter 4", shortened to "V6CH4".
+When I'm done with an anime or manga, I set the episode or chapter to 0 and set
+the status to "done".  
 
-You need to set the filepath to your csv in the main.c, but everything else
+You need to set the filepath to your db-file in the main.c, but everything else
 should work out of the box.  
 The Makefile uses clang, because that's what I prefer, 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
+gcc -o myal main.c -lsqlite3
+```
-- 
cgit v1.2.3