Selaa lähdekoodia

Updated documentation again

Ivan Safrin 14 vuotta sitten
vanhempi
sitoutus
d75775162d
2 muutettua tiedostoa jossa 29 lisäystä ja 1 poistoa
  1. 14 0
      BUILD.md
  2. 15 1
      BUILD.txt

+ 14 - 0
BUILD.md

@@ -163,6 +163,13 @@ templates and examples that will build out of the box.
 
 
 ## Building Polycode Lua ##
 ## Building Polycode Lua ##
 
 
+Note: To build a complete distribution of the standalone Lua tools
+as it appears in the binary release, you will need to build it on all
+supported platforms and copy the module libraries and deployment
+templates from all three into the folder. If you do not have access
+to all the supported platforms, you will not be able to build a complete
+distribution!
+
 To build Polycode Lua, you need to build the bindings and the player,
 To build Polycode Lua, you need to build the bindings and the player,
 which are disabled by default. To do this, you need to add a couple
 which are disabled by default. To do this, you need to add a couple
 of variables to the cmake commands above. To build the bindings, you
 of variables to the cmake commands above. To build the bindings, you
@@ -202,6 +209,13 @@ This will create a Standalone.sln solution in the Build directory. Build the
 This will create a Release/Windows/Standalone folder with the
 This will create a Release/Windows/Standalone folder with the
 same structure as the binary Polycode Lua release.
 same structure as the binary Polycode Lua release.
 
 
+### Final steps ###
+
+Since the standalone Lua distribution is supposed to compile packages for
+all platforms, you need to do this build step on all of the platforms and
+merge the Standalone/Modules and Standalone/Publish folders with the one
+you just built.
+
 ## TODO ##
 ## TODO ##
 
 
 It would be good to create a CMake build template for people to create
 It would be good to create a CMake build template for people to create

+ 15 - 1
BUILD.txt

@@ -163,6 +163,13 @@ templates and examples that will build out of the box.
 
 
 ## Building Polycode Lua ##
 ## Building Polycode Lua ##
 
 
+Note: To build a complete distribution of the standalone Lua tools
+as it appears in the binary release, you will need to build it on all
+supported platforms and copy the module libraries and deployment
+templates from all three into the folder. If you do not have access
+to all the supported platforms, you will not be able to build a complete
+distribution!
+
 To build Polycode Lua, you need to build the bindings and the player,
 To build Polycode Lua, you need to build the bindings and the player,
 which are disabled by default. To do this, you need to add a couple
 which are disabled by default. To do this, you need to add a couple
 of variables to the cmake commands above. To build the bindings, you
 of variables to the cmake commands above. To build the bindings, you
@@ -186,7 +193,7 @@ following commands in the Polycode source root:
     cmake -G "Unix Makefiles" ..
     cmake -G "Unix Makefiles" ..
     make install
     make install
 
 
-This will create a Release/<YourArchitecture>/Standalone folder with the
+This will create a Release/YourArchitecture/Standalone folder with the
 same structure as the binary Polycode Lua release.
 same structure as the binary Polycode Lua release.
 
 
 ### Windows ###
 ### Windows ###
@@ -202,6 +209,13 @@ This will create a Standalone.sln solution in the Build directory. Build the
 This will create a Release/Windows/Standalone folder with the
 This will create a Release/Windows/Standalone folder with the
 same structure as the binary Polycode Lua release.
 same structure as the binary Polycode Lua release.
 
 
+### Final steps ###
+
+Since the standalone Lua distribution is supposed to compile packages for
+all platforms, you need to do this build step on all of the platforms and
+merge the Standalone/Modules and Standalone/Publish folders with the one
+you just built.
+
 ## TODO ##
 ## TODO ##
 
 
 It would be good to create a CMake build template for people to create
 It would be good to create a CMake build template for people to create