aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorDavid Walter Seikel2012-09-06 12:53:15 +1000
committerDavid Walter Seikel2012-09-06 12:53:15 +1000
commitf983cb225fb92bd91d232c71cd348349a3dd3fe7 (patch)
treeebd93ccc74f02e55d4f45057c6e410397db732ca
parentInitial commit (diff)
downloadboxes-f983cb225fb92bd91d232c71cd348349a3dd3fe7.zip
boxes-f983cb225fb92bd91d232c71cd348349a3dd3fe7.tar.gz
boxes-f983cb225fb92bd91d232c71cd348349a3dd3fe7.tar.bz2
boxes-f983cb225fb92bd91d232c71cd348349a3dd3fe7.tar.xz
Fill out the readme.
-rw-r--r--README.md32
1 files changed, 31 insertions, 1 deletions
diff --git a/README.md b/README.md
index 17f8048..c8cb12f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,34 @@
1boxes 1boxes
2===== 2=====
3 3
4A test bed for a generic editor / pager thingy for the toybox project. \ No newline at end of file 4A test bed for a generic editor / pager thingy for the toybox project.
5
6The toybox project is at http://www.landley.net/code/toybox/ and boxes
7is covered by the same license that toybox is. Basically that's a two
8clause BSD license, but see the LICENSE file from toybox for details.
9
10This is a work in progress, proof of concept, playground, packaged up as
11one big toy, to be self contained until the mess is cleaned up. This
12"boxes" toy itself will go away, to be replaced by individual editor /
13pager toys and library bits. Nothing is set in stone, lots of mess
14inside, there's bugs, but at least it shows the general direction my
15mind is wandering in. As a bonus, it actually works, you can edit
16stuff.
17
18Please don't actually include this in toybox. Just look at it and sneer
19/ giggle, depending on your nature. Drop it into the toys directory to
20try it out, it's just one big toy.
21
22If you want to see how it can be used to build specific editors, start
23at the end and work backwards. Reading the lengthy comments at the
24beginning would also be useful.
25
26I've not even looked at it in the last month, just thought it was past
27time to show the code. I'll get back to working on it when I can.
28
29Toybox uses mecurial instead of git, but I keep all my stuff on github.
30Boxes will hopefully be incorporated into toybox in a highly altered
31form some day in the future. So this is just atemporary git repo for my
32convenience. If and when boxes migrates to toybox, this repo will be
33retired.
34