diff --git a/README.md b/README.md new file mode 100644 index 0000000..feeabf7 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# ƸӜƷ butterfly + +![](https://raw.github.com/paradoxxxzero/butterfly/master/butterfly.png) + + +## Description + +Butterfly is a tornado web server written in python which powers a full featured web terminal. + +The js part is heavily based on [term.js](https://github.com/chjj/term.js/) which is heavily based on [jslinux](http://bellard.org/jslinux/). + + +## Try it + +```bash + $ pip install butterfly + $ butterfly.server.py +``` + +Then open [localhost:57575](http://localhost:57575) in your favorite browser and done. + + +## Author + +[Florian Mounier](http://github.com/paradoxxxzero) + + +## License + +``` + butterfly Copyright (C) 2014 Florian Mounier + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . +``` diff --git a/butterfly.png b/butterfly.png new file mode 100644 index 0000000..7ac918c Binary files /dev/null and b/butterfly.png differ