From c0fcb5fc529600610d906e4accbf677b74e9bcb2 Mon Sep 17 00:00:00 2001 From: rocky Date: Sat, 19 Dec 2015 03:14:48 -0500 Subject: [PATCH] Docs --- LICENSE | 22 ++++++++++++++++++++++ README.rst | 19 +++++++++++++++---- 2 files changed, 37 insertions(+), 4 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..8d7df9b9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,22 @@ +Copyright (c) 1998-2002 John Aycock +Copyright (c) 2000 by hartmut Goebel +Copyright (c) 2015 by Rocky Bernstein + + Permission is hereby granted, free of charge, to any person obtaining + a copy of this software and associated documentation files (the + "Software"), to deal in the Software without restriction, including + without limitation the rights to use, copy, modify, merge, publish, + distribute, sublicense, and/or sell copies of the Software, and to + permit persons to whom the Software is furnished to do so, subject to + the following conditions: + + The above copyright notice and this permission notice shall be + included in all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY + CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, + TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE + SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.rst b/README.rst index 085f54b4..d8d4c833 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,16 @@ uncompyle6 ========== -A Python 2.x and 3.x byte-code decompiler. +A Python Byte-code Disassembler and Decompiler + Introduction ------------ -*uncompyle6* converts Python byte-code back into equivalent Python -source code. It accepts byte-codes from Python version 2.5 to 2.7. -It runs on Python 2.6 and 2.7 and Python 3.4 +A Python 2.x and 3.x byte-code decompiler. +*uncompyle6* translates Python byte-code back into equivalent Python +source code. It accepts byte-codes from Python version 2.5 to 2.7, and +runs on Python 2.6 and 2.7 and Python 3.4. The generated source is fairly readable: docstrings, lists, tuples and hashes are somewhat pretty-printed. @@ -65,6 +67,8 @@ sudo) will do the steps above. Testing ------- +:: + make check-2.7 # if running on Python 2.7 make check-3.4 # if running on Pyton 3.4 @@ -92,6 +96,13 @@ Known Bugs/Restrictions Support Python 3 bytecode and syntax is lacking. +See Also +-------- + +https://github.com/zrax/pycdc + + .. _trepan: https://pypi.python.org/pypi/trepan .. _debuggers: https://pypi.python.org/pypi/trepan3k .. _remake: https://bashdb.sf.net/remake +.. _pycdc: https://github.com/zrax/pycdc