From b8400d4977d14f63b5db22f52384dad01f8c39b0 Mon Sep 17 00:00:00 2001 From: Christopher Allan Webber Date: Sun, 22 Nov 2015 12:44:14 -0600 Subject: [PATCH] converting README to markdown from orgmode. Too bad Gogs doesn't read org. --- README.org => README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) rename README.org => README.md (67%) diff --git a/README.org b/README.md similarity index 67% rename from README.org rename to README.md index 33da05b..145d256 100644 --- a/README.org +++ b/README.md @@ -1,14 +1,16 @@ -#+TITLE: 8sync: an asynchronous programming library for Guile +8sync: an asynchronous programming library for Guile +==================================================== 8sync (pronounced "eight-sync") is an asynchronous programming library -for [[https://www.gnu.org/software/guile/][GNU Guile]]. +for [GNU Guile](https://www.gnu.org/software/guile/). Some features: - An asynchronous event loop! Non-blocking on ports and file access. - Easy to use! The =%sync= / =8sync= operator lets you write asynchronous code that looks simple while avoiding callback hell. - This happens through the magic of [[https://www.gnu.org/software/guile/manual/html_node/Prompts.html][delimited continuations]]. - ([[https://www.gnu.org/software/guile/manual/html_node/Shift-and-Reset.html#Shift-and-Reset][Hence the %]]!) + This happens through the magic of + [delimited continuations](https://www.gnu.org/software/guile/manual/html_node/Prompts.html). + ([Hence the %](https://www.gnu.org/software/guile/manual/html_node/Shift-and-Reset.html#Shift-and-Reset)!) - Provides building blocks on which you can build other asynchronous frameworks or paradigms on top of it (some of which will be included in the future), like: @@ -17,11 +19,16 @@ Some features: - web frameworks - your very heart's desire! -* How do I use it? +How do I use it? +---------------- -Hey, I ought to get some docs up, right? +For now, read the source ;) -* License +Hey, I ought to get some docs up, right? Soon, I promise! + + +License +------- Everything in here is LGPL v3 or later, as published by the Free Software Foundation, with exceptions below: -- 2.31.1