diff --git a/src/README.md b/src/README.md index 5df2b65..888dd4c 100644 --- a/src/README.md +++ b/src/README.md @@ -1,11 +1,20 @@ # Instructions For Running Manually -If you want to run from source or would like to use Picocrypt on any platform that supports Python, you're in the right place. To run Picocrypt from source, first install Python3 (any version >3.6 will do). Next, install these dependencies via pip: argon2-cffi, pycryptodome, and reedsolo. +If you want to run from source or would like to use Picocrypt on any platform that supports Python, you're in the right place. To run Picocrypt from source, first make sure you have Python3 installed (any version >3.6 will do). Then, download Picocrypt.py from above. Now, install these dependencies via pip: argon2-cffi, pycryptodome, reedsolo, and cython. -# Work in progress, be patient +Next, download tkinterdnd2.zip from above. Extract it and go into it. Inside, you'll see two Python files and a directory called tkdnd. -# A note about reedsolo -Picocrypt can use the raw reedsolo Python module by itself, but it is very slow because it's written in pure Python. It is recommended to compile a Python extension (.pyd/.so) for reedsolo, and name it creedsolo (ie. creedsolo.pyd or creedsolo.so). Make sure to include the extension in the same directory as Picocrypt.py. See here for instructions on building the extension. The Windows executable already bundles creedsolo.pyd, but for Linux or MacOS, you'll have to build the Python extension yourself if you want better speeds. Building the extension is not necessary if you don't intend on using the Reed-Solomon feature a lot, or if you are okay with slow Reed-Solomon speeds. Picocrypt will work just fine without the extension and just the way it is. +Now, find the directory where Python is installed. On Windows, for example, this folder would probably be here: +C:\Users\(Your username)\AppData\Local\Programs\Python\PythonXX. +Now, go into Lib/ and then site-packages. Create a folder named tkinterdnd2. Go into there and copy __init__.py and TkinterDnD.py from the folder you extracted (tkinterdnd2) earlier to here. + +Next, go back to the directory where Python is installed. Go into tcl/ and then tclX.X. Go into the same folder you extracted earlier (tkinterdnd2) and go into tkdnd/, and then go into your respective platform folder. Copy all the files there into the tclX.X directory you just went into. + +Finally, download reedsolo.zip from above, extract it, and go into the folder. Open up a terminal and python setup.py install. Then, python setup.py install --native-compile. Now you should now have a Python extension called reedsolo.pyd on Windows, reedsolo.so or reedsolo.dylib on MacOS, and reedsolo.so on Linux. Copy this file to the same directory where Picocrypt.py is. + +Now you're all good. Just python3 Picocrypt.py and enjoy! + +# External links