dirtywords

commit

10f50c69be5569655ed9adf4bd1a73990f61776f

parent

554112eea3dd2cf74ffbf0a93a4f225ac6567332

Author

Tobias Bengfort <tobias.bengfort@gmx.net>

Date

2014-10-07 17:53

create README

Diffstat

1 files changed, 20 insertions, 0 deletions

diff --git a/README.rst b/README.rst

@@ -0,0 +1,20 @@
   -1     1 dirtywords - protable text interface framework
   -1     2 
   -1     3 So I wanted to create a text interface and ended up creating a framework.  "Why
   -1     4 didn't you just stick with curses?" I hear you ask.  For two good reasons:
   -1     5 First, curses is not very portable.  It does not run on windows.  And it can
   -1     6 not be installed with pip.  The second reason of course is that I had fun with
   -1     7 this project.
   -1     8 
   -1     9 So what is this if not curses?  You can think of it as a wrapper around curses
   -1    10 with a different (though similar) API.  But the interesting thing about it is
   -1    11 that it implements a tiny set of functions with curses and builds the rest from
   -1    12 there.  And this tiny core can easily be implemented with other frameworks.
   -1    13 
   -1    14 There are currently three implementations of the core: One based on `curses`_,
   -1    15 another one based on `pygame`_, and a minimal implementation without any
   -1    16 dependencies outside of the standard library.
   -1    17 
   -1    18 
   -1    19 .. _curses: https://docs.python.org/2/library/curses.html
   -1    20 .. _pygame: http://pygame.org