]> git.huck.website - odot.git/commitdiff
sha256sums
authorHuck Boles <huck@huck.website>
Fri, 23 Dec 2022 22:12:50 +0000 (16:12 -0600)
committerHuck Boles <huck@huck.website>
Fri, 23 Dec 2022 22:12:50 +0000 (16:12 -0600)
.gitignore
README [new file with mode: 0644]
README.md [deleted file]
sha256sums [new file with mode: 0644]

index 583b95bb8f3830f42a215555880bbdd564982bf6..6074f070a50dda25da81038f3992c8e61d788d6f 100644 (file)
@@ -1,7 +1,8 @@
 *
 !.gitignore
+!sha256sums
 !LICENSE
-!README.md
+!README
 !Makefile
 !*.c
 !*.h
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..35bd1c2
--- /dev/null
+++ b/README
@@ -0,0 +1,65 @@
+odot
+
+Task manager written in C
+
+Installation:
+
+    - Arch Linux: Available in the AUR
+
+    - Manual: 
+
+            # Make and enter directory for odot
+        $ mkdir odot && cd odot
+
+            # Download source files
+        $ curl "https://download.huck.website/odot-0.2.0.tar.gz" > odot-0.2.0.tar.gz
+
+                    # Optional: Download and check pgp signature
+                $ curl "https://download.huck.website/odot-0.2.0.sig" > odot-0.2.0.sig
+                $ curl "https://download.huck.website/pub.asc" > huck.asc
+                $ gpg --import huck.asc
+                $ gpg --verify odot-0.2.0.sig odot-0.2.0.tar.gz
+
+            # Unpack source files
+        $ tar -xzvf odot-0.2.0.tar.gz 
+
+            # Build odot
+        $ sudo make install
+
+Usage:
+
+    Results are modified by options preceded by a dash.
+    Odot uses the first non-option as a subcommand.
+    The rest of the line is parsed into a task.
+
+    Available commands:
+        new     Adds a new task to the list
+        done    Marks a task on the list as complete
+        show    Shows current tasks in database
+        remove  Remove task from database
+
+    Available options:
+        -g (group)  Specify group for task
+        -a          Show all groups
+        -d          Also show completed tasks
+
+Examples:
+
+    Show tasks in default group:
+        $ odot show
+
+    Add a task called 'things to do' to a group called newgroup:
+        $ odot new -g newgroup things to do
+
+    Finish a task called 'thing I did' and show other completed tasks:
+        $ odot done thing I did -d
+
+    Show all completed tasks in a group called 'tasks':
+        $ odot show -dg tasks
+
+    Show all tasks in database:
+        $ odot show -da
+        
+    Remove a task from database (completely removes task from odot's memory, useful for typos):
+        $ odot remove task I want to forget
+
diff --git a/README.md b/README.md
deleted file mode 100644 (file)
index 83c94bf..0000000
--- a/README.md
+++ /dev/null
@@ -1,30 +0,0 @@
-# odot
-Todo manager written in C
-
-Extremely basic to use, simply call ***odot*** with a task to add or
-remove it from the list, or call ***odot*** all by iteself to see the
-current todo list in alphabetical order.
-
-* Usage:
-
-    - Add or remove a task from list:
-            $ odot [task]  
-    
-    - Show list:
-            $ odot 
-    
-* Installation:
-    - Arch Linux: Available in the AUR
-
-    - Manual Installation:
-
-            $ git clone https://github.com/huboles/odot.git
-            $ cd odot
-            $ sudo cc main.c -o /usr/bin/odot
-            $ mkdir $HOME/.local/state/odot
-
-***odot*** stores current and completed tasks in plaintext .txt files, located at
-$HOME/.local/state/odot.
-
diff --git a/sha256sums b/sha256sums
new file mode 100644 (file)
index 0000000..e28c0fb
--- /dev/null
@@ -0,0 +1,8 @@
+bb52d20fd00ac3d31299c348fe0ee8019df2371422988e73e6e2f9db89647e10  odot-0.2.0.tar.gz
+a45a3a517e7f181088127dd7ed8e225d2bdfcfbca2c603f38532d0104d9288b5  odot-0.2.0.sig
+aa2e0331dd78287d9a1a0644081185247e524224c80d0f5854f58b0260d7b699  odot.c
+42e2b1cff2f7e7f52a7381023c49c38ea758aee4d1d10d1201dd04648454a77f  database.c
+90328176ffceb8713eb28057f5f32248f931beba0baaacf7d318359eb6ec4555  odot.h
+c9d0adec9cba1e76de1007069cb5d440a050132ad0d15558ff60ec1377b9e178  Makefile
+4b9358d84670915008a62c55436fb6408878e7fdcd2fa675e6b58db1458ab529  sqlite3.o
+525ca99bf1f2bd871bb85aaa0ee3951d8e1db5434a73f23a3ac67696ab26a38c  sqlite3.h