Document fork.

Author: palkeo

README.md

@@ -1,92 +1,6 @@
-## Installation:
+This is a fork of: https://github.com/eveem-org/panoramix.git
 
-```
-git clone https://github.com/eveem-org/panoramix.git
-pip3 install -r requirements.txt
-```
+The goal of this fork is to maintain Panoramix in a decent shape, fix some crashes, implement missing opcodes...
 
-## Running:
-
-You *need* **python3.8** to run Panoramix. Yes, there was no way around it.
-
-```
-python3.8 panoramix.py address [func_name] [--verbose|--silent|--explain]
-```
-
-e.g.
-
-```
-python3.8 panoramix.py 0x06012c8cf97bead5deae237070f9587f8e7a266d
-```
-or
-```
-python3.8 panoramix.py kitties
-```
-
-Output goes to two places:
-- `console`
-- ***`cache_pan/`*** directory - .pan, .json, .asm files
-
-If you want to see how Panoramix works under the hood, try the `--explain` mode:
-
-```
-python3.8 panoramix.py kitties paused --explain
-python3.8 panoramix.py kitties pause --explain
-python3.8 panoramix.py kitties tokenMetadata --explain
-```
-
-### Optional parameters:
-
-func_name -- name of the function to decompile (note: storage names won't be discovered in this mode)
---verbose -- prints out the assembly and stack as well as regular functions, a good way to try it out is
-by running 'python panoramix.py kitties pause --verbose' - it's a simple function
-
-There are more parameters as well. You can find what they do in panoramix.py.
-
-### Address shortcuts
-Some contract addresses, which are good for testing, have shortcuts, e.g. you can run
-'python panoramix.py kitties' instead of 'python3 panoramix.py 0x06012c8cf97bead5deae237070f9587f8e7a266d'.
-
-See panoramix.py for the list of shortcuts, feel free to add your own.
-
-## Directories & Files
-
-### Code:
-- core - modules for doing abstract/symbolic operations
-- pano - the proper decompiler
-- utils - various helper modules
-- tilde - the library for handling pattern matching in python3.8
-
-### Data:
-- cache_code - cached bytecodes
-- cache_pan - cached decompilation outputs
-- cache_pabi - cached auto-generated p-abi files
-- supplement.db - sqlite3 database of function definitions
-- supp2.db - a lightweight variant o the above
-
-Cache directories are split into subdirectories, so the filesystem doesn't break down with large amounts
-of cached contracts (important when running bulk_decompile on all 2.2M contracts on the chain)
-
-All of the above generated after the first run.
-
-## Utilities
-bulk_decompile.py - batch-decompiles contracts, with multi-processing support
-bulk_compare.py - decompiles a set of test contracts, fetches the current decompiled from Eveem, and prepares two files, so you can diff them and see what changes were made
-
-## Why **python3.8** and **Tilde**
-Panoramix uses a ton of pattern matching operations, and python doesn't support those as a language.
-
-There are some pattern-matching libraries for older python versions, but none of them seemed good enough.
-Because of that, I built Tilde, which is a language extension adding a new operator.
-
-Tilde replaces '~' pattern matching operator with a series of ':=' operators underneath.
-Because of that, python3.8 is a must.
-
-Believe me, I spent a lot of time looking for some other way to make pattern matching readable.
-Nothing was close to this good.
-
-But if you manage to figure out a way to do it without Tilde (and maintain readability), I'll gladly accept a PR :)
-
-# How Panoramix works
-
-See the source code comments, starting with panoramix.py. Also, those slides[tbd].
+For now I only plan to implement very minor (but annoying fixes). If something is too complicated to understand or would require
+a non-negligible amount of time it won't be fixed.