From f983cb225fb92bd91d232c71cd348349a3dd3fe7 Mon Sep 17 00:00:00 2001 From: David Walter Seikel Date: Thu, 6 Sep 2012 12:53:15 +1000 Subject: Fill out the readme. --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 17f8048..c8cb12f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,34 @@ boxes ===== -A test bed for a generic editor / pager thingy for the toybox project. \ No newline at end of file +A test bed for a generic editor / pager thingy for the toybox project. + +The toybox project is at http://www.landley.net/code/toybox/ and boxes +is covered by the same license that toybox is. Basically that's a two +clause BSD license, but see the LICENSE file from toybox for details. + +This is a work in progress, proof of concept, playground, packaged up as +one big toy, to be self contained until the mess is cleaned up. This +"boxes" toy itself will go away, to be replaced by individual editor / +pager toys and library bits. Nothing is set in stone, lots of mess +inside, there's bugs, but at least it shows the general direction my +mind is wandering in. As a bonus, it actually works, you can edit +stuff. + +Please don't actually include this in toybox. Just look at it and sneer +/ giggle, depending on your nature. Drop it into the toys directory to +try it out, it's just one big toy. + +If you want to see how it can be used to build specific editors, start +at the end and work backwards. Reading the lengthy comments at the +beginning would also be useful. + +I've not even looked at it in the last month, just thought it was past +time to show the code. I'll get back to working on it when I can. + +Toybox uses mecurial instead of git, but I keep all my stuff on github. +Boxes will hopefully be incorporated into toybox in a highly altered +form some day in the future. So this is just atemporary git repo for my +convenience. If and when boxes migrates to toybox, this repo will be +retired. + -- cgit v1.1