diff options
Diffstat (limited to 'src/README')
-rw-r--r-- | src/README | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/src/README b/src/README new file mode 100644 index 0000000..7769eec --- /dev/null +++ b/src/README | |||
@@ -0,0 +1,27 @@ | |||
1 | Boxes is test bed for a generic editor / pager thingy for the toybox project. | ||
2 | |||
3 | The toybox project is at http://www.landley.net/code/toybox/ and boxes | ||
4 | is covered by the same license that toybox is. Basically that's a two | ||
5 | clause BSD license, but see the LICENSE file from toybox for details. | ||
6 | |||
7 | This is a work in progress, proof of concept, playground, packaged up as | ||
8 | one big toy, to be self contained until the mess is cleaned up. This | ||
9 | "boxes" toy itself will go away, to be replaced by individual editor / | ||
10 | pager toys and library bits. Nothing is set in stone, lots of mess | ||
11 | inside, there's bugs, but at least it shows the general direction my | ||
12 | mind is wandering in. As a bonus, it actually works, you can edit | ||
13 | stuff. | ||
14 | |||
15 | Please don't actually include this in toybox. Just look at it and sneer | ||
16 | / giggle, depending on your nature. Drop it into the toys directory to | ||
17 | try it out, it's just one big toy. | ||
18 | |||
19 | If you want to see how it can be used to build specific editors, start | ||
20 | at the end and work backwards. Reading the lengthy comments at the | ||
21 | beginning would also be useful. | ||
22 | |||
23 | Toybox uses mecurial instead of git, but I keep all my stuff on github. | ||
24 | Boxes will hopefully be incorporated into toybox in a highly altered | ||
25 | form some day in the future. So this is just a temporary git repo for | ||
26 | my convenience. If and when boxes migrates to toybox, this repo will be | ||
27 | retired. | ||