ref: bef630973910df30c0647daa2c6c8cbae4c6a50e
parent: 5e1d337617979642a8575fb90a167f75150c21d5
parent: 5bb32bae5f53118d6288deeaf4ed926a1021a108
author: Ori Bernstein <ori@eigenstate.org>
date: Fri Jan 22 06:09:05 EST 2016
Merge pull request #56 from felixangell/felixangell-readme-fix fixed the readme formatting
--- a/README.md
+++ b/README.md
@@ -1,8 +1,5 @@
-Myrddin
--------
-
+# Myrddin
[Myrddin Website and Documentation](http://eigenstate.org/myrddin/)
-~~~~~~
Myrddin is a systems language that is both powerful and fun to use.
It aims for C like low level control, a lightweight high quality implementation,
@@ -11,10 +8,9 @@
This combination makes Myrddin suitable for anything ranging from desktop
applications, to embedded systems and potentially even kernel development.
-Examples
---------
-
+## Examples
A classic:
+
```
use std
@@ -31,7 +27,9 @@
;;
}
```
+
How about regex, destructuring and algebraic data types?
+
```
use regex
use std
@@ -54,30 +52,22 @@
More examples and a complete feature list can be found on the website.
-Status
-------
-
+## Status
-Try It Online
--------------
-
+## Try It Online
The online playground is a good place to get started with little setup.
[Online Playground Environment](http://eigenstate.org/myrddin/playground/)
-API Documentation
--------------
-
+## API Documentation
Myrddin ships with standard library which covers many common uses. It is becoming
more useful every day.
[API Reference](http://eigenstate.org/myrddin/doc/)
-Mailing List
--------------
-
+## Mailing List
Annoucements of major changes, questions, complaints. We also give relationship advice.
[Mailing List Archives](http://eigenstate.org/archive/myrddin-dev/)
@@ -84,9 +74,7 @@
[Subscribe Here](http://eigenstate.org/myrddin/list-subscribe)
-Supported Platforms
--------------------
-
+## Supported Platforms
Myrddin currently runs on a number of platforms
- Linux