]> Nishi Git Mirror - gwion.git/commitdiff
:book: README [skip ci]
authorfennecdjay <astor.jeremie@wanadoo.fr>
Thu, 20 Jun 2019 19:24:37 +0000 (21:24 +0200)
committerfennecdjay <astor.jeremie@wanadoo.fr>
Thu, 20 Jun 2019 19:24:37 +0000 (21:24 +0200)
README.md

index 151faf004c6c764875d406ab9c37f03202e34d23..a6653cd2858d1cc9de6b4a21f4949582318a52fd 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,16 @@
+# Gwion
+Gwion is a programming language, aimed at making music
+
 [![Build Status](https://travis-ci.org/fennecdjay/Gwion.svg?branch=master)](https://travis-ci.org/fennecdjay/Gwion)
 [![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/fennecdjay/Gwion.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/fennecdjay/Gwion/context:cpp)
 [![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/2417/badge)](https://bestpractices.coreinfrastructure.org/projects/2417)
 [![All Contributors](https://img.shields.io/badge/all_contributors-3-brigthgreen.svg)](#contributors)
 <!--[![Coveralls branch](https://img.shields.io/coveralls/fennecdjay/Gwion/master.svg)](https://coveralls.io/github/fennecdjay/Gwion?branch=master)-->
 
-# Gwion
-gwion is a object-oriented programming language, aimed at making music
-
 **strongly** inspired by [chuck](http://chuck.stanford.edu/), but adding a bunch *high-level* features:  
-         templates, first-class functions and more.  
-
-:gift: a [plugin system](https://github.com/fennecdjay/Gwion-plug) makes it easily extendable
+         templating, first-class functions and more.  
+<!-- TODO: add benchmarks in doc and link to it -->
+It aims to be simple, small, fast, [extendable](https://github.com/fennecdjay/Gwion-plug) and embeddable.
 
 ### simple example code (hello_world.gw):
 
@@ -28,41 +28,26 @@ Still WIP :construction_worker: but a nice place to learn and [contribute](https
 
 ## Build
 ### Download the source
-This project makes use of submodules, so you can clone it with
-``` sh
-git clone --recursive https://github.com/fennecdjay/Gwion
-cd Gwion
-```
-or if you just want the minimum to start with, try
+You might just want the minimum to start with, try
 ``` sh
 git clone https://github.com/fennecdjay/Gwion
 cd Gwion
 git submodule update --init util ast
+make
 ```
 
-### Configure (optionnal)
-You might want to make sure every compile-time option is set to your liking.
-First list the files that set those.
+You can get a list of config files to tweak with
 ``` sh
 find . -name "config.mk"
 ```
-You can now edit then to your preference.
-
-> Besides develloper options, the most important one is *USE_DOUBLE*, in util/config.mk, which set the floating point size (float or double).
-
-### Compiling
-
-```
-make
-```
-
-### Other make targets
-Other basic targets include: clean install uninstall test
-
+> Besides develloper options, you migth want to check *USE_DOUBLE*, in util/config.mk, which set the floating point size (float or double).
 
 ## Reporting bugs / Contributing
 
 :+1: Every helping hand is welcome!!! :+1:  
+
+If there's anything you see that can make Gwion better, please let us know!
+
 :book: Please see the [contributing](.github/CONTRIBUTING.md) page for more information.
 
 ## Acknowledgements.