diff --git a/.travis.yml b/.travis.yml index 221d236..a887cea 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,7 +9,7 @@ install: - pip install -r requirements.txt script: - - python test/test_runner.py + - python test/run_tests.py notifications: email: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3201616..ebc69ff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,6 @@ -Thank you for considering contributing to the [imperialism remake](http://remake.twelvepm.de/) -open source game project! +## Introduction + +Thank you for considering contributing to the [Imperialism Remake](http://remake.twelvepm.de/)vproject! Volunteers are always welcome. There are plenty of chances to take part in coding, graphics design, discussing the game rules or just giving feedback. @@ -12,3 +13,60 @@ by forking and pushing merge requests are preferred. Please use the [issues tracker](https://github.com/Trilarion/imperialism-remake/issues) to report problems with the game. Requests for enhancement should be posted in the community forum or if they more technical (coding related) also at the issues tracker. + + +## Getting started + +### Sources + +The [source code](https://github.com/Trilarion/Imperialism-Remake) is on GitHub. + +#### Using Git + +[Download Git](http://git-scm.com/downloads) or on Windows install [TortoiseGit](https://code.google.com/p/tortoisegit/) +which conveniently integrates git with the explorer. + +Git is not easy. Be careful. Here is a [tutorial](https://www.atlassian.com/git/tutorials/syncing). + +Please use the usual fork and create pull request scheme for suggesting changes to the code. + +### Developer documentation + +- [![Documentation Status](https://readthedocs.org/projects/imperialism-remake-definition/badge/?version=latest)](http://imperialism-remake-definition.readthedocs.io/en/latest/?badge=latest) Game Design +- [![Documentation Status](https://readthedocs.org/projects/imperialism-remake-developer/badge/?version=latest)](http://imperialism-remake-developer.readthedocs.io/en/latest/?badge=latest) Developer Manual + +### Python environment + +Install [Python 3.X](https://www.python.org/downloads/). See also the [Python documentation](https://docs.python.org/3/). + +Only PyQt5 and [PyYAML](http://pyyaml.org/wiki/PyYAML) are required for running. Sphinx and sphinx_rtd_theme for creating the documentation. + +#### PyQt5 + +[PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5) is a Python binding of the Qt framework and is required for running. + +PyQt5 has not much [documentation](http://pyqt.sourceforge.net/Docs/PyQt5/) on its own but the [API classes overview](http://doc.qt.io/qt-5/classes.html) +of the underlying C++ Qt 5.X framework is very useful since PyQt5 is almost 100% recreating it. + +### Start the game + +- Run file `source/imperialism_remake/start.py` +- Start with command line parameter "--debug" for (more) output on the console. +- A folder with log files and settings is created under "user folder/Imperialism Remake User Data" where "user folder" is the typical user folder of your system (Windows: C:/Users/XXX/, Linux: ~/.config/). + +### Tests + +All tests in folder `test` can be run by executing `test/run_tests.py`. We also use Travis CI to run the tests +automatically. + +[![Build Status](https://travis-ci.org/Trilarion/imperialism-remake.svg?branch=master)](https://travis-ci.org/Trilarion/imperialism-remake) + +### IDE + +I use [PyCharm Community Edition](http://www.jetbrains.com/pycharm/download/). The `.idea` folder is included in the source, the project +can probably be opened directly with PyCharm. + +### Packaging + +Packaging on Linux and macOS has not progressed much so far. Windows packaging is with pynsist. Instructions will be added later. + diff --git a/README.md b/README.md index 58d455e..ad5ed61 100644 --- a/README.md +++ b/README.md @@ -1,83 +1,23 @@ # Imperialism Remake -**[Home](http://remake.twelvepm.de/) - [Community](http://remake.twelvepm.de/forum/) - [Sources](https://github.com/Trilarion/Imperialism-Remake) - [Download](http://remake.twelvepm.de/home/download/) - [Tasks](http://remake.twelvepm.de/tasks/) - [Contact](http://remake.twelvepm.de/home/contact/)** +**[Home](http://remake.twelvepm.de/) - [Community](http://remake.twelvepm.de/forum/) - [Sources](https://github.com/Trilarion/Imperialism-Remake) - [Download](http://remake.twelvepm.de/home/download/)** -## Documentation - -- [![Documentation Status](https://readthedocs.org/projects/imperialism-remake/badge/?version=latest)](http://imperialism-remake.readthedocs.io/en/latest/?badge=latest) Player Manual -- [![Documentation Status](https://readthedocs.org/projects/imperialism-remake-definition/badge/?version=latest)](http://imperialism-remake-definition.readthedocs.io/en/latest/?badge=latest) Game Design -- [![Documentation Status](https://readthedocs.org/projects/imperialism-remake-developer/badge/?version=latest)](http://imperialism-remake-developer.readthedocs.io/en/latest/?badge=latest) Developer Manual - -## Test - -[![Build Status](https://travis-ci.org/Trilarion/imperialism-remake.svg?branch=master)](https://travis-ci.org/Trilarion/imperialism-remake) - -## Requirements - -- Minimal screen size: 1024 x 768 -- Python (with some modules (see below) or included in a package) - -## Getting Started - -### Access the source code - -The [source code](https://github.com/Trilarion/Imperialism-Remake) is on GitHub. You can also download a zipped -[one-time snapshot](https://github.com/Trilarion/imperialism-remake/archive/master.zip). Otherwise just register -with GitHub and [fork the project](https://github.com/Trilarion/imperialism-remake). - -### Using Git - -[Download Git](http://git-scm.com/downloads) or on Windows install [TortoiseGit](https://code.google.com/p/tortoisegit/) -which conveniently integrates git with the explorer. - -Git is not easy. Be careful and read some instructions first. I liked this [tutorial](https://www.atlassian.com/git/tutorials/syncing). - -- Once you forked the project, clone it on your computer with "git clone https://github.com/USER/Imperialism-Remake.git" -- Regularly get updates with fetch/pull -- Programm as usual (commit) -- When task is done, create pull request. +Imperialism Remake is an open source game project to create a game very similar to the original Imperialism. It is written in Python. -### Python +## Download and requirements -Download and install latest [Python 3.X](https://www.python.org/downloads/). The [Python documentation](https://docs.python.org/3/) is quite good. +The current version can be found on the [download page](http://remake.twelvepm.de/home/download/). The packages for Windows, +Linux and macOS (if existing) will provide Python environments. The minimal screen size is 1024x768. -#### 32 or 64 bit on Windows - - Although it doesn't matter here, I use 64 bit and also deliver packages in 64 bit only. - -### Third Party Modules for Python - -Only PyQt5 and PyYAML are required for running. - -Sphinx, PyInstaller are additionally required for development. - -#### PyQt5 - -[PyQt5](https://www.riverbankcomputing.com/software/pyqt/download5) is a Python binding of the Qt framework and is required for running. - -PyQt5 has not much [documentation](http://pyqt.sourceforge.net/Docs/PyQt5/) on its own but the [API classes overview](http://doc.qt.io/qt-5/classes.html) -of the underlying C++ Qt 5.X framework is very useful since PyQt5 is almost 100% recreating it. - -#### PyYAML - -[PyYAML](http://pyyaml.org/wiki/PyYAML) is required for running. - -### Start - -- Run file `source/imperialism_remake/start.py` -- Start with command line parameter "--debug" for (more) output on the console. -- A folder with log files and settings is created under "user folder/Imperialism Remake User Data" where "user folder" is the typical user folder of your system (Windows: C:/Users/XXX/, Linux: ~/.config/). +## Documentation -### IDE +[![Documentation Status](https://readthedocs.org/projects/imperialism-remake/badge/?version=latest)](http://imperialism-remake.readthedocs.io/en/latest/?badge=latest) Player Manual -I use [PyCharm Community Edition](http://www.jetbrains.com/pycharm/download/). Since the `.idea` folder is contained the project -can probably be opened directly with PyCharm. Another nice IDE is [Spyder](https://code.google.com/p/spyderlib/). +## Community -### Tools +The community is centered around the [forum](http://remake.twelvepm.de/forum/) and the [Github project](https://github.com/Trilarion/imperialism-remake). -- [Inno Setup](http://www.jrsoftware.org/isinfo.php) is needed for the creation of the Windows installer. -- Many graphics are edited with [Inkscape](http://www.inkscape.org/en/). +## Feedback and contributions -### Packaging +Please post feedback on the forum and/or follow the [contribution guidelines](https://github.com/Trilarion/imperialism-remake/blob/master/CONTRIBUTING.md). -Under construction. diff --git a/requirements.txt b/requirements.txt index 14b617d..8d1b520 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ PyYAML>=3.1 -PyQt5>=5.6 \ No newline at end of file +PyQt5>=5.5 \ No newline at end of file diff --git a/test/test_runner.py b/test/run_tests.py similarity index 98% rename from test/test_runner.py rename to test/run_tests.py index 6761caa..1dca3ee 100644 --- a/test/test_runner.py +++ b/test/run_tests.py @@ -1,3 +1,5 @@ +#!/usr/bin/env python3 +# # Imperialism remake # Copyright (C) 2016 Trilarion # diff --git a/tools/build_documentation.py b/tools/build_documentation.py index d7555f7..d2ea2b7 100644 --- a/tools/build_documentation.py +++ b/tools/build_documentation.py @@ -1,3 +1,5 @@ +#!/usr/bin/env python3 + """ Builds the documentation. diff --git a/tools/taskboard/cache_header.html b/tools/taskboard/cache_header.html deleted file mode 100644 index cdf3f44..0000000 --- a/tools/taskboard/cache_header.html +++ /dev/null @@ -1,13 +0,0 @@ - - - - - Imperialism Remake - - - - -
- Project home • Community • Task Center -

Taskboard

-

\ No newline at end of file diff --git a/tools/taskboard/preferences.json b/tools/taskboard/preferences.json deleted file mode 100644 index 92f7d3c..0000000 --- a/tools/taskboard/preferences.json +++ /dev/null @@ -1 +0,0 @@ -{"categories":["General","Artwork","Programming"],"categories.colors":["EAEAFF","FFEAEA","EAFFEA"],"password.hash":"$2y$10$nm3TX05zNXUXKoRc.OBJsurrQRpaqPRsbIC6U6kCWJG2pweV9kwyS"} \ No newline at end of file diff --git a/tools/taskboard/tasks.db b/tools/taskboard/tasks.db deleted file mode 100644 index 2d2648a..0000000 Binary files a/tools/taskboard/tasks.db and /dev/null differ