534d2ae466
These are some minor changes I made after reviewing changes made by @Jammyjamjamman in these commits 464860aa023e4089f4c6f108e019d66d60052581 38a9356e203c05e2aec5e346363dd2707782262b f587c8548ff9d581ebf67082359a4e498ed45042 80af96b5cdf94fede7c357b592cd27647d68280b Jammy, I wrapped some lines. I've been told by project maintainers that when possible, keep lines in md files less than 79 chars or so. The files render the same when viewed through GitHub, so it's more for readability when editing. You'll find though there are times to break those rules. ;) (ping #13)
2.4 KiB
BUILD.md
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:
Procedure for cloning your forks
-
Create a new directory to clone your zetaglest-source and zetaglest-data into e.g. call it
ZetaGlest. -
Enter (or 'cd') into the new directory (
ZetaGlestin the example). -
clone zetaglest-source and zetaglest-data using the clone info provided by your fork. (Use the "Clone or Download" link, but do select
clonenotDownload Zip.) Make sure the cloned repo directories are in the same directory, adjacent to each other (and not in a subdirectory).
Note
If you have cloned the repositories this way, do not use the
git_update.sh provided in the source directory. See
syncing
for information on how to sync your repo with the main upstream (no,
you can't juse use merge).
Dependencies
Linux
On Debian, Ubuntu, Fedora, Opensuse and even more Linux distributions, after you clone the source repository, you may use
cd mk/linux
sudo ./setupBuildDeps.sh
which will run your package manager and attempt to install the needed packages.
(These may vary based on your operating system or Linux distribution; we will attempt to document dependencies in more detail)
Below is a list of most dependencies you will need. This document needs to indicate better which are optional and which are required.
gcc gcc-c++ cmake libsdl2-dev libalut-dev libgl1-mesa-dev libglu1-mesa-dev libvorbis-dev libx11-dev liblua-dev libjpeg-dev libpng-dev libcurl-gnutls-dev libircclient-dev libglew-dev libftgl-dev libfribidi-dev libcppunit-dev libminiupnpc-dev libfreetype6-dev libgnutls28-dev libkrb5-dev libkrb5-dev libnghttp2-dev libopenal-dev libldap2-dev libwxgtk3.0-dev librtmp-dev libvlccore-dev libvlc-dev
Additionally for map editor and model viewer:
libwxgtk3.0-dev libxml2-dev
Mac OS X
(Needs editing/updating)
Windows
(Need editing/updating)
*BSD
(Need editing/updating)
Other (add sections)
(Add other specific operating systems)
Compiling
Linux
./build-zg.sh
Mac OS X
./build-zg.sh
Windows
(Need editing/updating)
BSD
(Need editing/updating)