diff --git a/README.md b/README.md index 2291195..39b51b4 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,41 @@ # Wobbl tools -To install, make a new folder in the python site-packages folder named tools and put all files in it. +A python module for some projects by the Wobbler. -If a folder named tools already exists in the site-packages folder, you can name the folder "wobbl_tools" or something else. -Dont forget to change the imports in the script that uses this tools. +## Installation -To see, where the site-packages folder is, use: +You first have to check where your module folder is located. You can do this by running this command: + +```bash +python3 -m site ``` -python -m site + +The output should look like this: + +```bash +sys.path = [ + '/home/user', + '/usr/lib/python310.zip', + '/usr/lib/python3.10', + '/usr/lib/python3.10/lib-dynload', + '/home/user/.local/lib/python3.10/site-packages', + '/usr/local/lib/python3.10/dist-packages', + '/usr/lib/python3/dist-packages', + '/usr/lib/python3.10/dist-packages', +] +USER_BASE: '/home/user/.local' (exists) +USER_SITE: '/home/user/.local/lib/python3.10/site-packages' (exists) +ENABLE_USER_SITE: True ``` -You can use one of the listed folders. + +The path after "USER_SITE" is the path to your module folder. You have to `cd into the folder and clone this repository. +You can do that using these commands: + +```bash +cd /home/user/.local/lib/python3.10/site-packages +git clone https://teapot.informationsanarchistik.de/Wobbl/wobbl_tools.git +``` + +Dont forget to replace the path! + +And you are done! \ No newline at end of file