Changes between Version 357 and Version 358 of BuildInstructions

Timestamp:

Sep 1, 2019, 7:40:11 PM (5 years ago)

Author:

Krinkle

Comment:

Add high-level doc to explain workspaces

BuildInstructions

@@ -1 +1 @@
 [[TOC]]
 
-This page describes how to get the very latest unstable version of the code. Unless you want to actively follow and contribute to development, **you probably want the [https://play0ad.com/download latest relatively-stable release] instead.**
-
-The current release of the game is aimed at developers and not at 'normal' users. As such, the following instructions assume a reasonable level of technical proficiency. If you encounter difficulties, please post on the [https://www.wildfiregames.com/forum/index.php?showforum=312 forum].
-
-== General prerequisites ==
+This page describes how to install the latest development version of the code. This may be **unstable** and is intended for those that want to actively follow or contribute to the software development. **To install the latest alpha release,  [https://play0ad.com/download Download the Latest Alpha] instead.**
+
+The development version of the game is aimed at software developers (not regular players). As such, these instructions assume a higher level of technical proficiency. If you encounter difficulties, please consult the [https://www.wildfiregames.com/forum/index.php?showforum=312 forum].
+
+== System requirements ==
 You'll need:
 
@@ -20 +20 @@
  * Up-to-date system software (Windows service packs, graphics driver updates, etc)
  * Some technical proficiency. We try to make the build process as smooth and painless as possible, but it's designed to be followed by programmers - if you just want to play the game, wait for a pre-packaged installer instead.
+
+== Introduction ==
+
+The development environment for 0AD is comprised of three layers. Each goes on top of the previous:
+
+1. Libraries.
+2. Workspaces.
+3. Source code.
+
+Libraries are external dependencies (such as SpiderMonkey). For Windows and Linux, the script to create or update the Workspaces also handles installation and updating of libraries. For macOS, the `libraries/osx/build-osx-libs.sh` script should be used instead.
+
+Workspaces contain the integrations for code editors (such as Visual Studio, Xcode, etc.) as well as the Makefile for the main source code. The workspaces are auto-generated by the `update-workspaces` script from the `buids/workspaces/` directory.  Once ready, the integrations are ready for use, such as `build/workspaces/gcc/Makefile` (for Linux and macOS) and `build\workspaces\vc2015` (for Windows).
+
+Finally, the source code is build by the workspace. For example, by running `make` in `build/workspaces/gcc`.
 
 == Windows ==