summaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
authorLogan Hunt <loganjh@amazon.com>2022-05-24 09:57:15 -0700
committerLogan Hunt <loganjh@amazon.com>2022-05-24 09:57:15 -0700
commit3db9a2eb7a7d14ce935f5902b0c21ce4fd5eb729 (patch)
treef618b9a6342b8d30c39454e9cf7b3cabefc04db4 /README.org
downloadspeedrun-timer-3db9a2eb7a7d14ce935f5902b0c21ce4fd5eb729.tar.gz
speedrun-timer-3db9a2eb7a7d14ce935f5902b0c21ce4fd5eb729.zip
None of the original commit messages would actually help anyone
Diffstat (limited to 'README.org')
-rw-r--r--README.org10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.org b/README.org
new file mode 100644
index 0000000..c64eadf
--- /dev/null
+++ b/README.org
@@ -0,0 +1,10 @@
+* SBCL Speedrun Timer
+This is a complete rewrite of my first Lisp project: a speedrun timer. It uses ncurses and a SQLite database, with the [[https://github.com/fukamachi/mito][MITO ORM.]]
+** Requirements
++ [[https://www.quicklisp.org/beta/][Quicklisp]]
++ [[http://www.sbcl.org/platform-table.html][SBCL]]
+** Usage
+*** Importing categories
+Config files are documented by the examples in ~configs~. Once a config file is written, import that category and its splits by running ~sbcl --load main.lisp -i <path-to-config>~. This will add the category and its splits to the timer's SQLite database.
+*** Running
+Simply ~sbcl --load main.lisp~