From e3ba79428a6f6221ed5fb31b5a382c1f7bdb7b7a Mon Sep 17 00:00:00 2001 From: Calvin Rose Date: Fri, 16 Mar 2018 15:52:56 -0400 Subject: [PATCH] Update README.md --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index b1af4578..0be7f9cb 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,29 @@ are fairly straight forward. Dst can be easily ported to new platforms. * Lexical scoping * REPL +## Usage + +A repl is launched when the binary is invoked with no arguments. Pass the -h flag +to display the usage information. + +``` +$ ./dst +Dst 0.0.0 alpha Copyright (C) 2017-2018 Calvin Rose +> (+ 1 2 3) +6 +> (print "Hello, World!") +Hello, World! +nil +> (exit) +$ ./dst -h +usage: ./dst [options] scripts... +Options are: +-h Show this help +-v Print the version string +-r Enter the repl after running all scripts +$ +``` + ## Compiling and Running Dst is built using CMake. There used to be a hand-written Makefile, but in the interest of @@ -57,6 +80,11 @@ The repl can also be run with the CMake run target. make run ``` -### Example +### Examples -See the lin directory for some example dst code. +See the examples directory for some example dst code. + +### Editor + +There is some preliminary vim syntax highlighting in [dst.vim](https://github.com/bakpakin/dst.vim). +Generic lisp synatx highlighting should provide good results, however.