Update README.md
This commit is contained in:
parent
34fd4b96b7
commit
ad51dcea3c
32
README.md
32
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
|
#### Build Setup
|
||||||
* Version
|
|
||||||
* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
|
|
||||||
|
|
||||||
### How do I get set up? ###
|
``` bash
|
||||||
|
# build the application
|
||||||
|
mvn clean verify
|
||||||
|
|
||||||
* Summary of set up
|
# run the interpreter
|
||||||
* Configuration
|
java -jar target/transcendental-lisp-*-SNAPSHOT.jar
|
||||||
* Dependencies
|
|
||||||
* Database configuration
|
|
||||||
* How to run tests
|
|
||||||
* Deployment instructions
|
|
||||||
|
|
||||||
### Contribution guidelines ###
|
```
|
||||||
|
|
||||||
* Writing tests
|
|
||||||
* Code review
|
|
||||||
* Other guidelines
|
|
||||||
|
|
||||||
### Who do I talk to? ###
|
|
||||||
|
|
||||||
* Repo owner or admin
|
|
||||||
* Other community or team contact
|
|
Loading…
Reference in New Issue