summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorOri Bernstein <ori@eigenstate.org>2015-12-21 02:34:38 -0800
committerOri Bernstein <ori@eigenstate.org>2015-12-21 02:34:38 -0800
commitab7de6b01ad64a5abc10696f320664a6bc14a7fa (patch)
tree57e32f261941c42da753350abbfef4ad03f6cd28 /README.md
parent67e077fe5811a7bc218cb58de5a32e337417268c (diff)
downloadmc-ab7de6b01ad64a5abc10696f320664a6bc14a7fa.tar.gz
Update readme.
Links are better than half-assed duplication.
Diffstat (limited to 'README.md')
-rw-r--r--README.md68
1 files changed, 32 insertions, 36 deletions
diff --git a/README.md b/README.md
index 8ec8b27..e7c5cff 100644
--- a/README.md
+++ b/README.md
@@ -9,39 +9,44 @@ A Toy With Delusions of Usefulness
;;
}
-Myrddin is a language that I put together for fun, but which has developed
-delusions of usefulness. It's made by one coder with too little spare time on
-his hands.
+Myrddin is a language that I put together for fun, but which has slowly become
+a handly little language, and has attracted a number of contributors. The libraries
+are written from the ground up, with zero external dependencies -- not even libc.
-It is designed to be a simple programming language that runs close to the
-metal, giving the programmer predictable and transparent behavior and mental
-model. It also attempts to strong type checking, generics, type inference, and
-other features not present in C.
+![Solid Engineering](http://eigenstate.org/myrddin/tacoma-narrows.jpg "Solid Engineering")
+
+Introduction
+-------------
+
+If you want to read more about what Myrddin is or does, there's a website up.
-Myrddin is not a language designed to explore the forefront of type theory or
-compiler technology. It is not a language that is focused on guaranteeing
-perfect safety. It is satisfied to be a practical, small, fairly well defined,
-and easy to understand language for code that needs to be close to the
-hardware.
+### [Myrddin Homepage](http://eigenstate.org/myrddin/)
-In order to run, Myrddin currently requires an x86-64 computer running either
-Linux or OSX. Porting to other Posix-like OSes should be a matter of writing
-syscall wrappers.
+Try It Online
+-------------
-Why Myrddin?
-------------
+Since installing a new language is a chore, there is a sandbox with code you can mess
+around with.
-Are you tired of your compiler Just Working? Are you tired of having your
-standard library having the basic functionality you need? Do you long for the
-days when men were men, and debuggers operated on the assembly level? If so,
-Myrddin is for you.
+### [Online Playground: Type your code here and run it](http://eigenstate.org/myrddin/playground/)
-![Solid Engineering](http://eigenstate.org/myrddin/tacoma-narrows.jpg "Solid Engineering")
+API Documentation
+-------------
-More seriously, Myrddin has the goal of replacing C in its niche of OS and
-embedded development, but making it harder to shoot yourself in the foot. It's
-a language that matches the author's taste in design, and if other people want
-to use it, so much the better.
+Myrddin ships with a reasonably useful standard library, which covers many common uses. As
+stated before, This library is implemented from scratch.
+
+### [API Reference](http://eigenstate.org/myrddin/doc/)
+
+Supported Platforms
+-------------------
+
+Myrddin currently runs on a number of platforms
+
+- Linux
+- OSX
+- FreeBSD
+- 9front
Major Features
--------------
@@ -49,19 +54,10 @@ Major Features
- Type inference. Types are inferred across the whole program.
- Algebraic data types.
- And their friend, pattern matching.
-- Generics.
+- Generics and traits
- A package system.
- Low level control.
- (Almost) no runtime library.
- Entirely self contained.
- Simple and easy to understand implementation.
-Try It Online
--------------
-
-If you want to try before you buy, there is an online playground that you can
-use to experiment with code. It's fairly restrictive, and prevents you from
-using the vast majority of system calls, but it's enough to get a feel for
-things.
-
-[So, give it a shot.](http://eigenstate.org/myrddin/playground)