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

diff --git a/.gitignore b/.gitignore
index ecbc915834da92a001eb2106cf677c0d58e045f1..04a4376540f32e00af00e0ed96e4799090f8b444 100644 (file)
--- 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 b18458c2ebebd1f2d36493df557f4f03fa91d968..01b0cc7f93251ac6c2848630448df321b1d11762 100644 (file)
--- 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 cd084fd42aa51e234afbdbc7b71528df25ea72ee..bdbca9116fbb7e0c12143af1fe1be122b0286a47 100644 (file)
--- 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 (file)
index 0000000..8e81de6
--- /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 c85a7d94f3b4f90707cdaf6ba40a71924fb0bf8b..350d8285c899efa3e01aba9c7c0e7df5f094f562 100644 (file)
--- 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 d1fa51a6f6651e704f38503e469fe446d930e4f4..19eb38e8092f1a5b93dc87bc4f01544307e3f19f 100644 (file)
--- 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 e6d52ebc58e520eb289f15ac938ca1f756310f2a..48fb0ce070aa5d2bf2f422266d088c4e5df171ec 100644 (file)
--- 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