mirror-games/glest-source
1
0
Fork 0
mirror of https://github.com/glest/glest-source.git synced 2025-09-03 04:52:34 +02:00
Code Issues Projects Releases Wiki Activity

docs: moved info about cloning forks to CONTRIBUTING

Browse Source
This commit is contained in:
andy5995
2018-01-16 16:24:41 -06:00
parent c6d1d476d2
commit 2370c12add
2 changed files with 35 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
CONTRIBUTING.md
View File

@@ -31,6 +31,39 @@ 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 patch will consist of changes to several files. Keep unrelated patches separate
from each other (i.e. a separate PR for each patch). from each other (i.e. a separate PR for each patch).
## Set up the repositories locally
If you would like to contribute to development, you will need to
**fork* and then **clone your forks** of these 2 repositories:
* https://github.com/ZetaGlest/zetaglest-source
* https://github.com/ZetaGlest/zetaglest-data
Hint: make a `ZetaGlest` directory
* clone zetaglest-source
* cd zetaglest-source/data
* Important: clone the **data** repo into `glest_game/` by adding `glest_game` after the clone command
Example: `git clone https://github.com/ZetaGlest/zetaglest-data glest_game`
**Be sure to replace the URL with the URL of your fork**
### Dependencies
Information about dependencies is currently listed in the
[README](https://github.com/ZetaGlest/zetaglest-source#to-build-compile-and-run)
To build, change to the zetaglest-source/mk/`<OS>` directory, and run:
./build-zg.sh
To run the game, use:
./zetaglest
The path to the data is specified in `glest-dev.ini`. If `zetaglest`
can't find the data, you will receive an error message upon starting.
## Pull Requests ## Pull Requests
1. [Fork the repo](https://github.com/ZetaGlest/zetaglest-source/fork) (if you haven't already done so) 1. [Fork the repo](https://github.com/ZetaGlest/zetaglest-source/fork) (if you haven't already done so)
2. Clone it to your computer 2. Clone it to your computer

27
README.md
View File

@@ -82,31 +82,8 @@ To execute the game:
### Contributing and Testing ### Contributing and Testing
If you would like to contribute to development, you will need to If you'll be contributing code or changes to data, the procedures for
**fork* and then **clone your forks** of these 2 repositories: forking and cloning are outlined in [CONTRIBUTING.md](https://github.com/ZetaGlest/zetaglest-source/blob/develop/CONTRIBUTING.md)
* https://github.com/ZetaGlest/zetaglest-source
* https://github.com/ZetaGlest/zetaglest-data
Hint: make a `ZetaGlest` directory
* clone zetaglest-source
* cd zetaglest-source/data
* Important: clone the data repo into `glest_game/` by adding "glest_game" after the clone command
Example: git clone https://github.com/ZetaGlest/zetaglest-data glest_game
**Be sure to replace the URL with the URL of your fork**
Afterward, to build, change to the zetaglest-source/mk/<OS> directory, and run:
./build-zg.sh
To run the game, use:
./zetaglest
The path to the data is specified in `glest-dev.ini`. If `zetaglest`
can't find the data, you will receive an error message upon starting.
Please see [CONTRIBUTING.md](https://github.com/ZetaGlest/zetaglest-source/blob/develop/CONTRIBUTING.md) Please see [CONTRIBUTING.md](https://github.com/ZetaGlest/zetaglest-source/blob/develop/CONTRIBUTING.md)
for extended, important instructions and guidelines for contributing. for extended, important instructions and guidelines for contributing.