mirror-games/glest-source
1
0
Fork 0
mirror of https://github.com/glest/glest-source.git synced 2025-08-25 17:20:43 +02:00
Code Issues Projects Releases Wiki Activity

README.md: updated, CONTRIBUTING.md: added [skip ci]

Browse Source 
Quick guide to building and contributing
This commit is contained in:
andy5995
2018-01-13 23:12:35 -06:00
parent 76632e6b34
commit f8c6babf8b
2 changed files with 105 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,54 @@
# CONTRIBUTING
If you find an issue that interests you, please leave a note asking about it
first. If you don't see that anyone has inquired about it, you can simply
leave a note saying you are going to work on it. If people work on an issue
without saying they are working on it, the result is sometimes three people
submit a PR for the same issue.
If you find a problem for which no ticket has yet been created, please don't
hesitate to open a new ticket, and let us know if you are going to work on
that issue.
Please leave another note if you change your mind or if you get busy with other
things and are unable to finish it. That lets me and other people know the
ticket is available to be worked on by other people.
## Coding style
Please match the existing style
Sometimes a patch will be a single line in a single file; other times a single
patch will consist of changes to several files. Keep unrelated patches separate
from each other (i.e. a separate PR for each patch).
## Pull Requests
2. [Fork the repo](https://github.com/ZetaGlest/zetaglest-source/fork) (if you haven't already done so)
3. Clone it to your computer
4. When you're ready to work on an issue, be sure you're on the **develop** branch. From there,
[create a separate branch](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches)
(e.g. issue_32)
4. Make your changes. If you're unsure of some details while you're making edits, you can
discuss them on the ticket.
5. Commit your changes. [git-cola](https://git-cola.github.io/) is a nice GUI front-end for adding files and entering commit messages (git-cola is probably available from your OS repository).
6. Push the working branch (e.g. issue_32) to your remote fork and make your
[pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
* Do not merge it with the master branch on your fork. That would result in multiple, or
unrelated patches being included in a single PR.
7. If any further changes need to be made, comments will be made on the pull request.
It's possible to work on two or more different patches (and therefore multiple branches) at
one time, but it's recommended that beginners only work on one patch at a time.
### Syncing ###
Periodically, especially before starting a new patch, you'll need the sync your
repo with the remote upstream. GitHub has instructions for doing this:
1. [Configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/)
* For step 3 on that page, use https://github.com/ZetaGlest/zetaglest-source for the URL.
2. [Syncing a Fork](https://help.github.com/articles/syncing-a-fork/)
* On that page, it shows how to merge the **master** branch (steps 4 & 5 of **Syncing a Fork**).
Follow these steps if you are contributing to the
[data](https://github.com/ZetaGlest/zetaglest-data) or
[masterserver](https://github.com/MegaGlest/megaglest-masterserver)
repository.

69
README.md
View File

@@ -1,30 +1,63 @@
[![Build Status](https://travis-ci.org/ZetaGlest/zetaglest-source.svg?branch=develop)](https://travis-ci.org/ZetaGlest/zetaglest-source)
**This is the game engine source code repository.**
MegaGlest (http://megaglest.org) is a libre software cross
platform real-time strategy game.
[ZetaGlest](https://github.com/ZetaGlest) is a fork of [MegaGlest](http://megaglest.org/),
a libre software cross platform real-time strategy game.
![logo](http://megaglest.org/uploads/megaglest2011/logo/logo.png)
ZetaGlest is an entertaining free (freeware and free software) and open
source cross-platform 3D real-time strategy (RTS) game, where you
control the armies of one of seven different factions: Tech, Magic,
Egypt, Indians, Norsemen, Persian or Romans. The game is played in one
of 17 naturally looking settings, which, like the unit models, are
crafted with great attention to detail. A lot of additional game data
can be downloaded from within the game at no cost.
MegaGlest is an entertaining free (freeware and free software)
and open source cross-platform 3D real-time strategy (RTS) game,
where you control the armies of one of seven different factions:
Tech, Magic, Egypt, Indians, Norsemen, Persian or Romans. The
game is played in one of 17 naturally looking settings, which,
like the unit models, are crafted with great attention to
detail. A lot of additional game data can be downloaded from
within the game at no cost.
## Download executable files
[**MegaGlest Downloads**](http://megaglest.org/download.html)
No binary packages of the ZetaGlest fork have been released yet. If you
have no desire to compile software and would only like a binary
(executable), we suggest trying the [MegaGlest](http://megaglest.org/)
game; binary package downloads for various operating systems are
available on their web site.
![gif](http://megaglest.org/uploads/images/screenshots/game_screens.gif)
[> game trailer <](http://downloads.megaglest.org/videos/megaglest_game_trailer_lq.webm)
## To Build (Compile) and Run
If you want to compile MegaGlest yourself, you should read the following:
### Try the game without contributing
[Development Tutorial](https://docs.megaglest.org/MG/Development)
Use this command:
[Git Workflow](https://github.com/MegaGlest/megaglest-source/wiki/Git-How-To)
git clone --recursive https://github.com/ZetaGlest/zetaglest-source.git
Afterward, to build, change to the mk/ directory, select your operating
system and run
./build-mg.sh
Return to the main (upstream) repository [**here**](https://github.com/MegaGlest/megaglest-source)
### Contributing and Testing
If you would like to contribute to development, you will need to fork and
clone these 2 repositories:
* https://github.com/ZetaGlest/zetaglest-source
* https://github.com/ZetaGlest/zetaglest-data
* https://github.com/ZetaGlest/zetaglest-masterserver
Afterward, to build, change to the mk/<OS> directory, and run:
./build-mg.sh
To run the game, you will need to specify the data path:
./megaglest --data-path=<path to data repository>zetaglest-data/
If you don't provide the data page, you will receive an error message
when the game starts.
Please see [CONTRIBUTING.md](https://github.com/ZetaGlest/zetaglest-source/blob/develop/CONTRIBUTING.md)
for extended, important instructions and guidelines for contributing.
## Contact
* IRC: Freenode/#zetaglest-dev
* email: andy400-dev@yahoo.com