Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CMake docs. #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

LuisAntonRebollo
Copy link
Contributor

Docs for build project with CMake.

@crabmusket
Copy link
Contributor

Erk, I forgot. I'd like to fix the use of MAYOR in the CMake generator stuff before we make this happen. Looks good though :D. Maybe we can do a spelling/grammar pass later.

@LuisAntonRebollo
Copy link
Contributor Author

Fixed MAYOR in this PR GarageGames/Torque3D#636

I need to update some images from CMake docs.

@LuisAntonRebollo
Copy link
Contributor Author

Fixed images. I think we can merge.

@andr3wmac
Copy link

Everything looks good except I think the wording in the docs need a few corrections.

ProjectName will be used later, and you have to choose one to use the same in the following steps. For example: TestProject

This is not very clear. Should probably say something like "ProjectName will be used in these instructions. Replace each instance with your desired ProjectName. Example .. "

Set Where to build de binaries: Full path to Torque3D to build CMake cache and MSVC solution files. Torque root path + /My Projects/ + ProjectName + /buildFiles/CMake For example: G:/Torque3D/My Projects/TestProject/buildFiles/CMake

"Where to build de binaries" should be "Where to build the binaries" and "Full path to Torque3D to build CMake cache and MSVC solution files." should probably be more clear like "Full path to output project build files (such as MSVC solution)."

We will see this error message. Is normal, we have to set the name of the project.

This should be "You will see an error message. This is normal, we have to set the name of the project."

Red are new configuration variables.

Should be "The new configuration variables are marked in red."

Where to build de binaries

Where to build the binaries.

Build INSTALL project/target first and ONLY ONE. INSTALL project build all projects and then copy template files on your game directory.
For future builds use ALL_BUILD.

I don't fully understand this so I can't rewrite it. Can you clarify what this step means?

@crabmusket
Copy link
Contributor

@andr3wmac Thanks for that. I figured I'd go through and do that later after this was accepted, since the loop is tighter that way (i.e. no need to critique -> Luis make changes -> update PR). WRT that last part, the INSTALL project should be 'compiled' first and only once, before any other projects are compiled. It copies the template scripts and so on into the project folder. Then every subsequent build, the ALL_BUILD project should be compiled. Or possibly a different one: see GarageGames/Torque3D#623.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants