use markdown readme

This commit is contained in:
Milan Nikolic 2014-01-23 13:52:36 +01:00
parent 8e6cdee904
commit 1291b34c77
4 changed files with 65 additions and 108 deletions

43
README
View file

@ -1,43 +0,0 @@
_____ __ __
____ ___ / ___// // / ____ __ __
/ __ `__ \/ __ \/ // /_/ __ \/ / / /
/ / / / / / /_/ /__ __/ /_/ / /_/ /
/_/ /_/ /_/\____/ /_/ / .___/\__, /
/_/ /____/
http://m64py.sourceforge.net
A frontend for Mupen64Plus
About
-----
M64Py is a Qt4 front-end (GUI) for Mupen64Plus 2.0, 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
--------
* ROMs list with preview images
* Input bindings configuration
* Cheats support
* Support gzip, bzip2, zip, rar and 7z archives
* Video extension (embedded OpenGL window)
Dependencies
------------
* PyQt4
* SDL-1.2 or SDL-2.0
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.

2
dist/debian/docs vendored
View file

@ -1 +1 @@
README
README.md

View file

@ -1,62 +1,62 @@
[Setup]
AppName=M64Py
AppVerName=M64Py {VERSION}
VersionInfoVersion={VERSION}
AppPublisher=
AppPublisherURL=http://m64py.sourceforge.net/
AppSupportURL=
AppUpdatesURL=
DefaultDirName={pf}\M64Py
DefaultGroupName=M64Py
AllowNoIcons=yes
OutputDir=.
Uninstallable=yes
WindowVisible=no
AppCopyright=Author: Milan Nikolic <gen2brain@gmail.com>
OutputBaseFilename=m64py-{VERSION}-setup
UninstallDisplayIcon={app}\m64py.exe
LicenseFile=m64py\COPYING
DisableStartupPrompt=yes
ChangesAssociations=yes
[Tasks]
Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}";
[Files]
Source: "m64py\*.ttf"; DestDir: "{app}";
Source: "m64py\*.ini"; DestDir: "{app}";
Source: "m64py\*.txt"; DestDir: "{app}";
Source: "m64py\*.pyd"; DestDir: "{app}";
Source: "m64py\*.exe"; DestDir: "{app}";
Source: "m64py\*.dll"; DestDir: "{app}";
Source: "m64py\AUTHORS"; DestDir: "{app}";
Source: "m64py\COPYING"; DestDir: "{app}";
Source: "m64py\README"; DestDir: "{app}";
Source: "m64py\ChangeLog"; DestDir: "{app}";
Source: "m64py\*.v64"; DestDir: "{app}\test";
Source: "m64py\qt4_plugins\codecs\*.dll"; DestDir: "{app}\qt4_plugins\codecs";
Source: "m64py\qt4_plugins\iconengines\*.dll"; DestDir: "{app}\qt4_plugins\iconengines";
Source: "m64py\qt4_plugins\imageformats\*.dll"; DestDir: "{app}\qt4_plugins\imageformats";
Source: "m64py\doc\*"; DestDir: "{app}\doc";
[Icons]
Name: {group}\M64Py; Filename: {app}\m64py.exe; Tasks: desktopicon;
Name: {group}\{cm:ProgramOnTheWeb,m64py}; Filename: http://m64py.sourceforge.net/;
Name: {group}\{cm:UninstallProgram,m64py}; Filename: {app}\unins000.exe;
Name: {userdesktop}\M64Py; Filename: {app}\m64py.exe; Tasks: desktopicon;
[Registry]
Root: HKCR; Subkey: ".v64"; ValueType: string; ValueData: "Mupen64Plus.Document"; Flags: uninsdeletevalue
Root: HKCR; Subkey: "Mupen64Plus.Document"; ValueType: string; ValueData: "Nintendo64 ROM"; Flags: uninsdeletekey
Root: HKCR; SubKey: Mupen64Plus.Document\DefaultIcon; ValueType: string; ValueData: {app}\m64py.ico;
Root: HKCR; SubKey: Mupen64Plus.Document\shell\open\command; ValueType: string; ValueData: """{app}\m64py.exe"" ""%1""";
Root: HKCR; SubKey: ".z64"; ValueType: string; ValueData: "Mupen64Plus.Document"; Flags: uninsdeletevalue;
Root: HKCR; SubKey: Mupen64Plus.Document; ValueType: string; ValueData: "Nintendo64 ROM"; Flags: uninsdeletekey;
Root: HKCR; SubKey: Mupen64Plus.Document\DefaultIcon; ValueType: string; ValueData: {app}\m64py.ico;
Root: HKCR; SubKey: Mupen64Plus.Document\shell\open\command; ValueType: string; ValueData: """{app}\m64py.exe"" ""%1""";
[Run]
Filename: {app}\m64py.exe; Description: {cm:LaunchProgram,m64py}; Flags: nowait postinstall skipifsilent;
[Dirs]
Tasks: desktopicon; Name: {ICON};
[Setup]
AppName=M64Py
AppVerName=M64Py {VERSION}
VersionInfoVersion={VERSION}
AppPublisher=
AppPublisherURL=http://m64py.sourceforge.net/
AppSupportURL=
AppUpdatesURL=
DefaultDirName={pf}\M64Py
DefaultGroupName=M64Py
AllowNoIcons=yes
OutputDir=.
Uninstallable=yes
WindowVisible=no
AppCopyright=Author: Milan Nikolic <gen2brain@gmail.com>
OutputBaseFilename=m64py-{VERSION}-setup
UninstallDisplayIcon={app}\m64py.exe
LicenseFile=m64py\COPYING
DisableStartupPrompt=yes
ChangesAssociations=yes
[Tasks]
Name: "desktopicon"; Description: "{cm:CreateDesktopIcon}"; GroupDescription: "{cm:AdditionalIcons}";
[Files]
Source: "m64py\*.ttf"; DestDir: "{app}";
Source: "m64py\*.ini"; DestDir: "{app}";
Source: "m64py\*.txt"; DestDir: "{app}";
Source: "m64py\*.pyd"; DestDir: "{app}";
Source: "m64py\*.exe"; DestDir: "{app}";
Source: "m64py\*.dll"; DestDir: "{app}";
Source: "m64py\AUTHORS"; DestDir: "{app}";
Source: "m64py\COPYING"; DestDir: "{app}";
Source: "m64py\README.md"; DestDir: "{app}";
Source: "m64py\ChangeLog"; DestDir: "{app}";
Source: "m64py\*.v64"; DestDir: "{app}\test";
Source: "m64py\qt4_plugins\codecs\*.dll"; DestDir: "{app}\qt4_plugins\codecs";
Source: "m64py\qt4_plugins\iconengines\*.dll"; DestDir: "{app}\qt4_plugins\iconengines";
Source: "m64py\qt4_plugins\imageformats\*.dll"; DestDir: "{app}\qt4_plugins\imageformats";
Source: "m64py\doc\*"; DestDir: "{app}\doc";
[Icons]
Name: {group}\M64Py; Filename: {app}\m64py.exe; Tasks: desktopicon;
Name: {group}\{cm:ProgramOnTheWeb,m64py}; Filename: http://m64py.sourceforge.net/;
Name: {group}\{cm:UninstallProgram,m64py}; Filename: {app}\unins000.exe;
Name: {userdesktop}\M64Py; Filename: {app}\m64py.exe; Tasks: desktopicon;
[Registry]
Root: HKCR; Subkey: ".v64"; ValueType: string; ValueData: "Mupen64Plus.Document"; Flags: uninsdeletevalue
Root: HKCR; Subkey: "Mupen64Plus.Document"; ValueType: string; ValueData: "Nintendo64 ROM"; Flags: uninsdeletekey
Root: HKCR; SubKey: Mupen64Plus.Document\DefaultIcon; ValueType: string; ValueData: {app}\m64py.ico;
Root: HKCR; SubKey: Mupen64Plus.Document\shell\open\command; ValueType: string; ValueData: """{app}\m64py.exe"" ""%1""";
Root: HKCR; SubKey: ".z64"; ValueType: string; ValueData: "Mupen64Plus.Document"; Flags: uninsdeletevalue;
Root: HKCR; SubKey: Mupen64Plus.Document; ValueType: string; ValueData: "Nintendo64 ROM"; Flags: uninsdeletekey;
Root: HKCR; SubKey: Mupen64Plus.Document\DefaultIcon; ValueType: string; ValueData: {app}\m64py.ico;
Root: HKCR; SubKey: Mupen64Plus.Document\shell\open\command; ValueType: string; ValueData: """{app}\m64py.exe"" ""%1""";
[Run]
Filename: {app}\m64py.exe; Description: {cm:LaunchProgram,m64py}; Flags: nowait postinstall skipifsilent;
[Dirs]
Tasks: desktopicon; Name: {ICON};

View file

@ -107,7 +107,7 @@ class build_exe(Command):
dest_path = join(self.dist_dir, "m64py")
shutil.copy(unrar_dll, dest_path)
shutil.copyfile(unrar_lic, join(dest_path, "doc", "unrar-license"))
for file in ["AUTHORS", "ChangeLog", "COPYING", "LICENSES", "README"]:
for file in ["AUTHORS", "ChangeLog", "COPYING", "LICENSES", "README.md"]:
shutil.copy(join(BASE_DIR, file), dest_path)
def remove_files(self):
@ -187,7 +187,7 @@ class build_dmg(Command):
if not os.path.exists(dest_path):
os.mkdir(dest_path)
shutil.move(join(self.dist_dir, "M64Py.app"), dest_path)
for file in ["AUTHORS", "ChangeLog", "COPYING", "LICENSES", "README"]:
for file in ["AUTHORS", "ChangeLog", "COPYING", "LICENSES", "README.md"]:
shutil.copy(join(BASE_DIR, file), dest_path)
shutil.copy(join(BASE_DIR, "test", "mupen64plus.v64"), dest_path)