From: Amber <amberisvibin@gmail.com>
Date: Thu, 17 Sep 2020 15:38:48 +0000 (+0000)
Subject: Docs: edit README, add authors, adjust contrib [skip benchmark]
X-Git-Url: http://10.10.0.4:5575/?a=commitdiff_plain;h=71ce1b63d5e60708d31942ed4f02c1d8f0ffc0bf;p=gwion.git

Docs: edit README, add authors, adjust contrib [skip benchmark]
---

diff --git a/.gitignore b/.gitignore
index ecbc9158..04a43765 100644
--- a/.gitignore
+++ b/.gitignore
@@ -3,3 +3,4 @@ book
 log
 *.gw
 ansi2html*
+.replit
\ No newline at end of file
diff --git a/book.toml b/book.toml
index b18458c2..01b0cc7f 100644
--- a/book.toml
+++ b/book.toml
@@ -1,5 +1,5 @@
 [book]
-authors = ["Jérémie Astor"]
+authors = ["Jérémie Astor", "Pranav Joglekar", "Amber Zeller"]
 title = "Gwion"
 
 [output.html]
diff --git a/docs/BuildingTheDocs.mdr b/docs/BuildingTheDocs.mdr
index cd084fd4..bdbca911 100644
--- a/docs/BuildingTheDocs.mdr
+++ b/docs/BuildingTheDocs.mdr
@@ -1,4 +1,4 @@
-# How this doc is build
+# How this doc is built
 
 ## This is basically markdown
 All documentation files are in docs.
diff --git a/docs/Contributing/ContributingCode.mdr b/docs/Contributing/ContributingCode.mdr
new file mode 100644
index 00000000..8e81de6a
--- /dev/null
+++ b/docs/Contributing/ContributingCode.mdr
@@ -0,0 +1,3 @@
+# Contributing Code
+
+> stub, to be filled
\ No newline at end of file
diff --git a/docs/Contributing/ContributingDocumentation.mdr b/docs/Contributing/ContributingDocumentation.mdr
index c85a7d94..350d8285 100644
--- a/docs/Contributing/ContributingDocumentation.mdr
+++ b/docs/Contributing/ContributingDocumentation.mdr
@@ -2,8 +2,8 @@
 
 > this is a stub for now, this place deserves better
 
-You might be here because you found something you could improve in [Gwion](https://github.com/fennecdjay/Gwion)'s documentation.
-Please open a [issue](https://github.com/fennecdjay/gwion-docs/issues) describing the problem and how you might address it.
+You might be here because you found something you could improve in [Gwion's documentation](https://github.com/fennecdjay/gwion-docs).
+Please open an [issue](https://github.com/fennecdjay/gwion-docs/issues) describing the problem and how you might address it.
 
 
 ## Dependencies
diff --git a/docs/Contributing/list b/docs/Contributing/list
index d1fa51a6..19eb38e8 100644
--- a/docs/Contributing/list
+++ b/docs/Contributing/list
@@ -1,3 +1,4 @@
 README.md
+ContributingCode.md
 ContributingDocumentation.md
 ContributingTranslation.md
diff --git a/docs/README.mdr b/docs/README.mdr
index e6d52ebc..48fb0ce0 100644
--- a/docs/README.mdr
+++ b/docs/README.mdr
@@ -1,23 +1,32 @@
 # Welcome to Gwion
 
-:gwion: is a strongly timed programming language,   
-aiming to be easy, powerful and [fast](Benchmarks.html) strongly-timed programming language, 
+:gwion: is a strongly timed programming language for making music.
+
+It is strongly influenced by [chuck](http://chuck.stanford.edu/), but adds a bunch of high-level features:
+templating, first-class functions and more.
+
+It aims to be simple, small, [fast](https://fennecdjay.github.io/Gwion/#Benchmarks/), [extendable](https://github.com/fennecdjay/Gwion-plug) and [embeddable](https://github.com/fennecdjay/Gwion/blob/master/src/main.c#L18-L31).
+
+gwion was originally designed and created by [Jérémie Astor](https://github.com/fennecdjay). They are a musician, who made it to assist in their shows/compositions.
+
+We are currently looking for contributions, you can learn how to make some [here](https://fennecdjay.github.io/Gwion/Contributing/).
 
 ## And now for the hello world
 
 Here is the piece of code you're waiting for :tada::
 
-@``` helloworld.gw
+@```helloworld.gw
 <<< "Hello, World!" >>>;
 @```  
 @hide make -s CONTAINS="Hello, World!" helloworld.test
 
 ## (Bag of) Features
-  * [single inheritance](https://en.wikipedia.org/wiki/Inheritance_(object-oriented_programming)#Design_constraints)
-  * typedef (function pointers and type aliases)
-  * [enums](Reference/Types/Enums.html) and [unions](Reference/Types/Unions.html) 
-  * templates (both class and functions)
-  * easy concurrency/async
-  * [lambdas](Reference/Functions/Lambdas.html)
-  * [memoization](Reference/Preprocessor.md#Memoization)
-  * [variadic](Reference/Functions/Variadic.html) functions
+
+* [single inheritance](https://en.wikipedia.org/wiki/Inheritance_(object-oriented_programming)#Design_constraints)
+* typedef (function pointers and type aliases)
+* [enums](Reference/Types/Enums.html) and [unions](Reference/Types/Unions.html)
+* templates (both class and functions)
+* easy concurrency/async
+* [lambdas](Reference/Functions/Lambdas.html)
+* [memoization](Reference/Preprocessor.md#Memoization)
+* [variadic](Reference/Functions/Variadic.html) functions