Browse Source

📚 update docs

Christopher P. Brown 4 years ago
parent
commit
6e3e6d1e69
3 changed files with 13 additions and 4 deletions
  1. 13 4
      docs/README.md
  2. BIN
      docs/img/hotswap.gif
  3. BIN
      docs/img/repl.gif

+ 13 - 4
docs/README.md

@@ -1,4 +1,4 @@
-# Fennel Test
+# Fennel Pong
 
 Scaffolding a love2d project to use Fennel
 
@@ -20,9 +20,18 @@ This was a learning exercise for me, and the end result is largely the result of
 
 - Get to write lisp for awesome lua frameworks like love2d and TIC-80
 
-- Hot swapping / live reloading (not unique to fennel. You can apparently use [lume/hotswap](https://github.com/rxi/lume#lumehotswapmodname) to do this in pure Lua)
+- Hot swapping / live reloading
 
-- REPL driven development (if you embed fennel in your lua)
+    - ![hotswapping](./img/hotswap.gif)
+    - Load changes to your code with a keypress without restarting your app
+    - not unique to fennel. You can apparently use [lume/hotswap](https://github.com/rxi/lume#lumehotswapmodname) to do this in pure Lua
+
+- REPL driven development
+
+    - ![repl](./img/repl.gif)
+    - embed fennel in your lua and start its REPL, and any global variables are available in your REPL to inspect and tweak while your code is running.
+
+- Full Lua interop: call any and all lua functions, built in or from a library
 
 **Cons**:
 
@@ -69,4 +78,4 @@ Put this step in your Makefile or something to compile `.fnl` files into `.lua`
 
 ### Community
 
-Visit #fennel on freenode.net
+Visit #fennel on freenode.net

BIN
docs/img/hotswap.gif


BIN
docs/img/repl.gif