diff --git a/ChangeLog b/CHANGELOG similarity index 100% rename from ChangeLog rename to CHANGELOG diff --git a/MANIFEST.in b/MANIFEST.in index fad7e72..d9f2811 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,4 +1,4 @@ -include setup.py m64py AUTHORS README.md ChangeLog COPYING LICENSES +include setup.py m64py AUTHORS README.rst CHANGELOG COPYING LICENSES recursive-include src *.py *.ui *.qrc *.svg *.png *.jpg *.ts recursive-include xdg *.desktop *.png *.xml global-exclude *_ui.py *_rc.py diff --git a/README.md b/README.md deleted file mode 100644 index 056bfb0..0000000 --- a/README.md +++ /dev/null @@ -1,45 +0,0 @@ - - _____ __ __ - ____ ___ / ___// // / ____ __ __ - / __ `__ \/ __ \/ // /_/ __ \/ / / / - / / / / / / /_/ /__ __/ /_/ / /_/ / - /_/ /_/ /_/\____/ /_/ / .___/\__, / - /_/ /____/ - http://m64py.sourceforge.net - A frontend for Mupen64Plus - -### About - -M64Py is a Qt5 front-end (GUI) for Mupen64Plus, a cross-platform -plugin-based Nintendo 64 emulator. Front-end is written in Python and it -provides a user-friendly interface over Mupen64Plus shared library. - -### Features - -* Changeable emulation plugins for audio, core, input, rsp, video -* Selection of emulation core -* Configuration dialogs for core, plugin and input settings -* ROMs list with preview images -* Input bindings configuration -* Cheats support -* Support gzip, bzip2, zip, rar and 7z archives -* Video extension (embedded OpenGL window) - -### Dependencies - -* [PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5) (QtCore, QtGui, QtWidgets, QtOpenGL) -* [PySDL2](https://pysdl2.readthedocs.io) - -##### Ubuntu -```sudo apt-get install python-pyqt5 pyqt5-dev-tools python-pyqt5.qtopengl libsdl2-dev``` - -### Install - -Run *python setup.py install* to install - -Run *python setup.py build_qt* before you can start ./m64py from source dir - -### License - -M64Py is free/libre software released under the terms of the GNU GPL license, -see the `COPYING' file for details. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..da36a1d --- /dev/null +++ b/README.rst @@ -0,0 +1,79 @@ +:: + + _____ __ __ + ____ ___ / ___// // / ____ __ __ + / __ `__ \/ __ \/ // /_/ __ \/ / / / + / / / / / / /_/ /__ __/ /_/ / /_/ / + /_/ /_/ /_/\____/ /_/ / .___/\__, / + /_/ /____/ + http://m64py.sourceforge.net + A frontend for Mupen64Plus + + +About +===== + +M64Py is a Qt5 front-end (GUI) for Mupen64Plus, a cross-platform +plugin-based Nintendo 64 emulator. Front-end is written in Python and it +provides a user-friendly interface over the Mupen64Plus shared library. + +Features +======== + +* Changeable emulation plugins for audio, core, input, rsp, video +* Selection of emulation core +* Configuration dialogs for core, plugin and input settings +* ROMs list with preview images +* Input bindings configuration +* Cheats support +* Support gzip, bzip2, zip, rar and 7z archives +* Video extension (embedded OpenGL window) + +Dependencies +============ + +* `PyQt5 `_ (QtCore, QtGui, QtWidgets, QtOpenGL) +* `PySDL2 `_ + +Ubuntu +++++++ + +``sudo apt-get install python-pyqt5 pyqt5-dev-tools python-pyqt5.qtopengl +libsdl2-dev`` + +PyPi +++++ + +To install just the Python dependencies: + +``pip install -r requirements.txt --user`` + +.. note:: + + This will not install the other system dependencies which are listed above. + + You can also drop the ``--user`` flag and run as root user if you want to + install system-wide, but this is not recommended, as this will likely + screw up your distro's package management. + +Install +======= + +First, run ``python setup.py build`` followed by ``python setup.py install`` +to install + +.. code:: + + python setup.py build + python setup.py install --user + +.. note:: + + If you use the ``--user`` flag, make sure ``~/.local/bin`` is in your + user's path environment variable. + +License +======= + +M64Py is free/libre software released under the terms of the GNU GPL license. +Please see the ``COPYING`` file for details. diff --git a/m64py b/bin/m64py similarity index 100% rename from m64py rename to bin/m64py diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..f9b68da --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +pyqt5 +pysdl2 diff --git a/setup.py b/setup.py index dda2ae3..4ac8932 100644 --- a/setup.py +++ b/setup.py @@ -15,10 +15,11 @@ import distutils.command.build as distutils_build import distutils.command.clean as distutils_clean import setuptools -from m64py.core.defs import FRONTEND_VERSION - +# Add the src folder to the path sys.path.insert(0, os.path.realpath("src")) +from m64py.core.defs import FRONTEND_VERSION + BASE_DIR = os.path.dirname(os.path.realpath(__file__)) @@ -413,9 +414,9 @@ setuptools.setup( author_email="gen2brain@gmail.com", license="GNU GPLv3", url="http://m64py.sourceforge.net", - packages=["m64py", "m64py.core", "m64py.frontend", "m64py.ui"], package_dir={'': "src"}, - scripts=["m64py"], + packages=["m64py", "m64py.core", "m64py.frontend", "m64py.ui"], + scripts=["bin/m64py"], requires=["PyQt5", "PySDL2"], platforms=["Linux", "Windows", "Darwin"], cmdclass={