summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFelix Angell <felixangell1024@gmail.com>2016-01-22 18:55:13 +0000
committerFelix Angell <felixangell1024@gmail.com>2016-01-22 18:55:13 +0000
commit5bb32bae5f53118d6288deeaf4ed926a1021a108 (patch)
treee945676c60f44c6e23e3b4d866b1c916343128ea /README.md
parent5e1d337617979642a8575fb90a167f75150c21d5 (diff)
downloadmc-5bb32bae5f53118d6288deeaf4ed926a1021a108.tar.gz
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 10 insertions, 22 deletions
diff --git a/README.md b/README.md
index f214cce..85f551a 100644
--- 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 @@ and features you may find familiar from languages like like rust and ocaml.
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 @@ const main = {
;;
}
```
+
How about regex, destructuring and algebraic data types?
+
```
use regex
use std
@@ -54,39 +52,29 @@ const main = {
More examples and a complete feature list can be found on the website.
-Status
-------
-
+## Status
![Solid Engineering](http://eigenstate.org/myrddin/tacoma-narrows.jpg "Solid Engineering")
-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/)
[Subscribe Here](http://eigenstate.org/myrddin/list-subscribe)
-Supported Platforms
--------------------
-
+## Supported Platforms
Myrddin currently runs on a number of platforms
- Linux