Add README and TODO

2025-01-01 13:49:08 -08:00
parent e436ad9aa7
commit c0c7475b36
2 changed files with 52 additions and 0 deletions
@@ -0,0 +1,28 @@
+GoComics Downloader
+===================
+
+This tool should not be used to download comics that you can't download, or to
+pirate. Only use this to download comics that you are able to download (like
+public domain, or CC licensed comics).
+
+What this does
+--------------
+
+GoComics downloader downloads comics from gocomics.com. If you have already
+downloaded comics, it will resume from the last comic downloaded. The comics are
+put in a folder, which is named the comic id.
+
+How to use
+----------
+
+### Command-line args
+
+To run with command line args, run:
+```
+./downloader.py <comic_id>
+```
+
+### Edit the code
+
+The start of the file contains the variable `comic_id`. Look at the comment
+above it.
@@ -0,0 +1,24 @@
+TODO list
+=========
+
+Help would be appreciated with the maintainance and building of this tool.
+Here's the features or changes I want to get done:
+
+ - Better command line arg support
+
+The command line only takes one arg (comic id). This should be expanded to
+resume date as well. In addition, the program only takes the arg if `comic_id`
+is set to `False`. I want to have the command line arg override the comic id set
+in code.
+
+---
+
+That's all the features. More will come later. If you want to help, either get
+an account on SDF git (where this is hosted), or send me an email with:
+
+ - Name or pseudonym (username is fine)
+ - Changes (preferable in a computer readable format)
+ - What is changed
+ - Any other info I need to know
+
+My email is <ilikecats@sdf.org>. GMail and Outlook will likely not work.