diff --git a/README.md b/README.md index 153c0c6..ec2a0d0 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,15 @@ -# Transcendental Lisp # +# Transcendental Lisp -A dialect of Lisp still in its early stages of development. +> A dialect of Lisp still in its early stages of development. -### What is this repository for? ### -* Quick summary -* Version -* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo) +#### Build Setup -### How do I get set up? ### +``` bash +# build the application +mvn clean verify -* Summary of set up -* Configuration -* Dependencies -* Database configuration -* How to run tests -* Deployment instructions +# run the interpreter +java -jar target/transcendental-lisp-*-SNAPSHOT.jar -### Contribution guidelines ### - -* Writing tests -* Code review -* Other guidelines - -### Who do I talk to? ### - -* Repo owner or admin -* Other community or team contact \ No newline at end of file +``` \ No newline at end of file