From a0ad2ebb0b96a4444cdbf793fe7aeb09b9ba6d07 Mon Sep 17 00:00:00 2001 From: Trilarion Date: Mon, 24 Jul 2017 22:37:25 +0200 Subject: [PATCH] extracted and separated contribution guidelines from readme also deleted not needed taskboard data --- .travis.yml | 2 +- CONTRIBUTING.md | 62 ++++++++++++++++++- README.md | 82 ++++---------------------- requirements.txt | 2 +- test/{test_runner.py => run_tests.py} | 2 + tools/build_documentation.py | 2 + tools/taskboard/cache_header.html | 13 ---- tools/taskboard/preferences.json | 1 - tools/taskboard/tasks.db | Bin 17408 -> 0 bytes 9 files changed, 77 insertions(+), 89 deletions(-) rename test/{test_runner.py => run_tests.py} (98%) delete mode 100644 tools/taskboard/cache_header.html delete mode 100644 tools/taskboard/preferences.json delete mode 100644 tools/taskboard/tasks.db 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 2d2648a9645d018a9781a41094ec5cc64f072b26..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 17408 zcmeHPTWlOzTCVD9$8i!nmr3HxIIB5PU}G~*kL^h^lSDJ%B%a8#x!ajA>`0k%)#>iq zbXRq%s_l5BVbq=MvO);)vS=lCg+Kx!t%QVx1VXzk4^ZjvOPg^JdwK(Yf&??&BvFz^@_Bwy%{O;o}-ah`6D{!N@WB8?) z>~~Ukp{A4jHSFZwMBi`f&|Cdy-^E)q)AKWGe)__d8MW%#(a^2yaojof@L*s6@bIwx zm44|nb(4FEG=&xSzbD7uQ=@~s24;P=;xl_~e&+JbEp_esyt;P#$`y6v*6h{kTkohZ z%)FzfZ_i(!y@tN7&Rm;Ux3A6Kygf6HPA4R$L=biM7i!m+-W;XD{i74t=a$pc8Y}*JZa^OVx=Jyn8xHf=a0U z`DmlF-M&}eeKD#xYPvhF$DLj8{;{$C9mB5=+g5<_J;*lCZKjd@eOET)?v(s0j_r8z zrIT{0=yM-LZov5)3f_L_f1Uqv{?qw)=LgO|JOAYTojLrJGP!;EkLLvuX9obiE=}wAEa4Ve&jXlI!u)>+Px5j73J1yD#h)KZX86-1gBCrs3m+H z56dIn&{x%Hi3gTd5T+QhmzLCQszR;(L^YZVwZKz;ka$ffHwMc)yeNdt!_#8D7$kUB zNnL2B*&KsZCDo`|^VNbzm&#Rs?3Pni3+`cxDGZB(AFXK@>%k$T)85er^+ps+=M6Vb zG0lA7+UNI1gkivzV~n9pBg7)8sgtj$dK9MB1cQ+E#wa*a%qujLz#iZjyg2@Z{Oub- zv-b#^p+jf}>Be^rp&8hXX6Ftx{Z#)Q_AazXonNq=A42y(cK*%z7w7xX{J(bo()n}e z&zwJT{?Pe-=l7i7cD~{Ky7Oz!FFTK%UvwTgu~T!(&U?6V`?I|Q+bgin3iLU)ee@{X zkrB2pyukMP=h+@P!ghF=?cu|04;^BA@F3ggo@0C90Nefh+3wrNcJE%cLqlu_2ifk~ z!*=&>w!3z*9T;G{b0^#WezrSyurt##BhY}<(!1;3tHeK)}`>-yt+ab*~Ar%U2771oQ3S`IXOzeAy6Iwh)#;r#a3UhaIBO!B9Y$i5&;7cGz=56)=aeTyjyIYw{Ky4+yugLA?6Hk zET>frxCbZY!l)o$m8$81#|*B3&h6gvsSTo6+xc$`Kii+}71&;ZpM(_{u$^IBIDn&~ z|AjFNKii+}6?ps#Y{&n?aeM~i|5cnuX=-Bf)X9l6CnqQ8mBi}5K2)6(diM?uMa^7+m-5jXRuXj+5PLw7~ zr^Zy(1x{7vW+*rukQmr424|E-LoUJ)T?;Tg7dVtb5JM$!R0i@gL=vQH_$$Cqa8_A( zv;zKm)yPCB39jLmmejN%#1OZXf!zguOYj4Hxtt?Xz)|u}1i+jd*d&ZlsIn}?TF{;g zz{<1BK1KMI9M6;OfDj>V&fCNAtNJ~6RKCm;&E}v$i4!;Cm z5EP({9x(t(JCJH110}SQbb_ zC`I(=)tbIG;?)@q1ug_%Sf}QFL z=6b3&E#XuS_aQJ-rHL^Nx+fOMNIeXFF2KlcrV3oAj|&nAR)S~(d|x&ntkNvzkaS{& zYz7MXpJ36gVYN6=F2ouU&c=E6Z{pYg*Qb4G#~}20uzmm7UYedB zHC`KAXGUd{QRkb~uwL$&Yl+AhHYtJ>ASmY=U8YE0(&Se~%C5R0HWyljSQ-JaP|_WS z!33My^{Nn31o!A5h_NwzOiJ#X0UJ4NpNy{Q5Ro3AV}e?VX-n!#9&ejxV7nNJcBN?Q zbo*2v*X4RUGA4O5>#|jG^o9#}?@0@H4U=(0Z&|?{H>!aLy?d((&2-hx%h{2)Nd{5h zRxQjpE=r@Qw&2FfT_B5LY$7=6_tto_PtFO_%_xEp#b#ahsGAXj7B56_ z1w5am%Us(V#_##Yi{Pe;7E=q41eYL&#Sllzt$+g+4p0O*0b>Z60l}q4;edqv95b9* zZ|$TRAofuDR;Db%9R(Cv4 zrcNO}ZVfmn6P~0_3`;l)EEQ@XybQikM2u$;^WU>nueOH!F|-d`eVZ6s=G~q|$xd@$ zh+|*}D#p}~t1r>QavU(705))Dbx1VEE|v%zO)J>DiD!)e|GHK9zWw*s*FP<)Z&~d( zhUoZSd^l+G%{|h!WeJCQEEEwp)6I%l8wqX0^ydKi_H0Q32>?I4%SdOdQGmP{>po6r z4A`7wT1;=mtQ3xbgGr^v#%^5Fk8;1E1oBmuaZ&JTB{Lr^ z%20#hOFXxslcUO+dCU#Qg^y6N=^Wk;5=8&-yut-!Y*|N5kG$$6z5M`dx$yT0F#sV@ zUyuU;2?%J!vm=L3ICJ*f2oa)=-9T&zC=f?JGUm)oGk}N=9dj;A|6P;{Cz4SZuo+?c z+^u5kgj}+rGw+ltNaX@JM$lInsBui=3Ira56C44YI56Uzx94GbP?mQmW=*)zu4L1a zeV@2EVk`3A+48Spu?kDY)_r?ECR74E%quTC9+?PQ3~W!?K!SLu*?_U-O`u}MO|r5> zc$}`^%q{>|iZVyTd5$GVZWh>ozfpL`AC8gQNwEzG%dM{6cfJwAP@}}M6j=iN+USYl6tcl zc-;Yk z6(6*;%3cY@AEcdWPMmEY-b?Ab-`>A=o+JIQS6ZpbKk#=OhfJ6nB4VwcK zmoVcb#B)vnAWS?<{V!Tat-|*Tr>y_Nm!41S_929jbM05nnq>ssCLCDD1e?f5oSGV) zJUK;5q6zsJQ%j(PQ5Dz2jdHv+%n%TSx#AT;1p83nG)RO*lYUC-Hj++|c@%C_QgV8^ z8|uJlljg`{cql&;MIB+7Jkx&tAm%mp2-L#oFtt3*i3fLa_dL}PKTH%cxJ&Mdb#O6* z>@vx}NRCS4_4poij}`$hdEgu0&Y)6@+^Z};D@VC2B10q^0HyY-+CL}EjF=?@0`oKx zLq5q8_Ez`dAgoQ6`7`=rI6c8Xqjgux2Qy|1VT+_C5H;kr@+KPzzwhG>5(X1cwj^zq z%f?m&X_s4=JTpTRiul1WZD&tTo@ssVIoOQLtuL(6rHq=%D;ZaU7FrIIW~57%mFuK2 z32H#KMDW01D{&!pKj*ECDZ~}r5SG*73P~sC#4IzI-Tj?tj~!stf8uGmkEel4m<%kD zux#Xq7JBX#u1#EsVS5mF!AZdOttM4^%33kydY1O=I4fgPWplcGG`fi*pKlwyTt_%r zV_@p4g&GYhDpHw0rfKzoNU=(=1NER%6-o(0L)Hl}rbibhjQ{_x<@`+Hr%(g%S^KmX zjzAP|K3ZQCH-_;YD;0vShxb7`Q1k{bee{5TS;Q=~;F3~?yYGpK@(CZ@d9kCXP$4%# zj2xJEHUWxgId&NZ!s5X49Xe+?A;Mi;KdzRMVqy=S00E^Bj4}Yoc^DfhIVfmx&wyY# z`TmLk-zDxpREA731(1dl7Q)l4$)yeoI)?PZ2!W6?HPN{}?da3gWZM~ry{xo9H2R*| z%co*C=2!*MLrGv2yD!~jKn$Y+S=~*ybmA>c8Y6_gbh}oP>(`-BxGTJx912-6*(SWp zM|6~1=;NB( z9XZknuVglv@PFxm>UyGC86q;sM7{|I1+IEA%12;08qhDH^D_lE8-o55(mvFf$2%uZ`P3b`Bs|odM14cM31Z`?vL?mSy%zt0Y;;y$1+)_dPo_`QsCoU zm-Ll@)hIq`#s@45G9IIj_gaIKl2br^OOx;L!IQ{LATu2inVOnB)q3j%+SvBU8h8I> zsuWpCWGz-hcCkC1s7JJs%xcEAaIOSW0E#H8Xof;~%A+JS!XQb>QnFzL2yCI|c=G`@ z{hb%{a`g2+cQ1;%)0u1!KF`TKJho;sPbPFf!DJQ#(*GJb+`N`Nt{SH5Uso!lKRZU- zy$}EdXEd`gF`smnA`G+^Ts*8LV_caOZ7nz^)(?q`@q5;T`fnHh!NSk>XL|*Hj8>q1 z{3tYCKRmrjudqI6oX3H9&lgFxz~g@hVCr&i2y07FlG*nj50m#b3JZmVpk#@&6fbn1 zQ8Dwz0v70yK-K_&Ww~Xe{+*{u=~)(1bUae5D*%Iu(y3Q6{7(WW#Zm-f2-*NCu{6U_ Oct07I)QobqasNMPpDi)~