knotteye
/
plchat
1
0
Fork 0
Code Issues 1 Pull Requests Releases 4 Activity

Update readme

develop
knotteye 2021-04-17 12:09:52 -05:00
parent 82b1e9c0e2
commit 76b015a6f0
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -9,8 +9,12 @@ Run the binary or `python plchat.py`. Log in to your account on the fediverse an
Installation instructions for PlChat. If you are looking to package this program or build from source, skip to Building From Source or Packaging down below. Installation instructions for PlChat. If you are looking to package this program or build from source, skip to Building From Source or Packaging down below.
### Windows ### Windows
Download and install [python 3.8.9](https://www.python.org/downloads/windows/) from the website and the [k-lite codec pack](https://www.codecguide.com/download_kl.htm). The basic version with default options should work fine.
Download the latest plchat_windows.zip from https://git.waldn.net/git/knotteye/plchat/releases extract the zip file and run plchat.exe
### Linux ### Linux
A prepackaged deb file is provided in https://git.waldn.net/git/knotteye/plchat/releases
If you package plchat for your distro, please let me know and I will add instructions here.
### MacOS ### MacOS
@ -19,12 +23,12 @@ PlChat comes with a Makefile for compiling to a binary, but it is of course poss
Otherwise you can see below for instructions on building the binary. Otherwise you can see below for instructions on building the binary.
### Runtime Depencies ### Runtime Depencies
You will need QtPy and a compatible set of bindings, either PyQt4/5 or Pyside/PySide2, all available on PyPI. You will need the following system libraries: Qt4 or 5 (maybe be optional, the pypi package includes a copy of required libraries in some cases), Secret Service (on linux or BSD), libmagic, and some codecs for qtmultimedia.
You will also need the following system libraries: Qt4 or 5 (depending on your bindings), Secret Service (on linux or BSD), and libmagic. The windows codecs can be found above, and on linux you will need gstreamer and some plugins. On gentoo, `sudo emerge media-plugins/gst-plugins-base media-plugins/gst-plugins-good media-plugins/gst-plugins-bad media-plugins/gst-plugins-ugly media-plugins/gst-plugins-neon media-plugins/gst-plugins-soup media-plugins/gst-plugins-libav` should do. Other distributions are on your own.
And, obviously, a copy of python. Python3.5+ is the only thing I will support but other versions may work. And, obviously, a copy of python. Python3.5+ is the only thing I will support but other versions may work. End users will need the same version of python used to compile the binary. Other versions may work but this is what nuitka officially supports.
### Building ### Building
You will need the following packages from pypi: keyring, appdirs, python-magic, python-dateutil, and websockets. You will need the following packages from pypi: PyQt5, keyring, appdirs, python-magic, python-dateutil, and websockets.
You will also need all runtime dependencies listed above, as well as nuitka3 and a C compiler compiler. Nuitka supports the following compilers: You will also need all runtime dependencies listed above, as well as nuitka3 and a C compiler compiler. Nuitka supports the following compilers:
* gcc 5.1+ or g++ 4.4+ * gcc 5.1+ or g++ 4.4+
@ -33,6 +37,4 @@ You will also need all runtime dependencies listed above, as well as nuitka3 and
Cross compilation is not supported so you will need to compile on the OS and architecture that you are targeting. Cross compilation is not supported so you will need to compile on the OS and architecture that you are targeting.
Once everything is installed and in your path it should be a simple `make && sudo make install` to build everything. The resulting binary will have it's own copy of all the python build dependencies, which can then be uninstalled or ignore. You can also `make systemlibs` if you wish, and the resulting binary will rely on system packages for all python modules listed above as build depencies. Once everything is installed and in your path it should be a simple `make && sudo make install` to build everything. The resulting binary will have it's own copy of all the python build dependencies, which can then be uninstalled or ignored. You can also `make systemlibs` if you wish, and the resulting binary will rely on system packages for all python modules listed above as build depencies. Nuitka produces very large binaries. UPX works well if you want to reduce the size.
Nuitka produces very large binaries. UPX works well if you want to reduce the size.