summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 20 insertions, 6 deletions
diff --git a/README.md b/README.md
index 356bd7f..3cbb194 100644
--- a/README.md
+++ b/README.md
@@ -25,11 +25,25 @@ Then a binary named `tempest` will be produced. Run it.
Only `.lisp` file whose content starts with `;;;; TEMPEST` will be built.
-# Todos
+## Development
-- [ ] Integrate [Parenscript](https://parenscript.common-lisp.dev/), compile `.lisp` to `.js` or `<script>` embedded in `.html`.
-- [ ] `.lisp` to `.css`.
-- [ ] Parse metadata defined in header comments, e.g. `;;;; OUT = ...` specifies a destination.
-- [ ] Add macros for writing [Go templates](https://pkg.go.dev/text/template), e.g. `(mu ...)` to `{{ ... }}`, `(mu-if ...)` to `{{ if }}...{{ end }}`...
-- [ ] Add macros for writing [Vue](https://vuejs.org/) templates
+Make sure you have [SBCL](https://www.sbcl.org/), [GNU Make](https://www.gnu.org/software/make/) (or any other implementation) and [rlwrap](https://github.com/hanslub42/rlwrap) (not necessary, but used in some make commands) installed in your environment.
+
+Start an REPL with tempest loaded.
+
+```sh
+make repl
+```
+
+Start a [Swank](https://github.com/brown/swank-client) server for [SLIME](https://en.wikipedia.org/wiki/SLIME), [conjure](https://github.com/Olical/conjure) for Neovim or your editor of choice.
+
+```sh
+make repl-server
+```
+
+Build binary.
+
+```sh
+make build
+```