ShuriZma
/
xenia-canary
mirror of https://github.com/xenia-canary/xenia-canary.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
xenia-canary/docs/building.md

117 lines
3.0 KiB
Markdown
Raw Normal View History

Updating building docs.
2013-02-24 19:44:10 +00:00
# Building
You must have a 64-bit machine for building and running the project. Always
run your system updater before building and make sure you have the latest
video drivers for your card.
## Setup
Support for VS2013 (and auto picking), a Win xb script, and readme updates. This also removes the dependency on D3DX, which is only included in the DXSDK, meaning that just the Win8+ SDK should be required now.
2013-10-18 06:35:54 +00:00
### Windows
Update python script and building manual
2014-01-14 06:05:10 +00:00
* Windows 8 or 8.1
Updating README to reflect VS2015 requirement.
2015-02-06 02:16:55 +00:00
* Visual Studio 2015
Update python script and building manual
2014-01-14 06:05:10 +00:00
* [Python 2.7](http://www.python.org/download/releases/2.7.6/)
* If you are on Windows 8, you will also need the [Windows 8.1 SDK](http://msdn.microsoft.com/en-us/windows/desktop/bg162891)
Support for VS2013 (and auto picking), a Win xb script, and readme updates. This also removes the dependency on D3DX, which is only included in the DXSDK, meaning that just the Win8+ SDK should be required now.
2013-10-18 06:35:54 +00:00
Removing OSX/Linux info from docs for now.
2013-11-16 09:15:17 +00:00
Ensure Python is in your PATH (`C:\Python27\`).
Support for VS2013 (and auto picking), a Win xb script, and readme updates. This also removes the dependency on D3DX, which is only included in the DXSDK, meaning that just the Win8+ SDK should be required now.
2013-10-18 06:35:54 +00:00
XamLoaderTerminateTitle asserts now to make it easier to track death.
2014-10-25 18:42:54 +00:00
I recommend using [Cmder](http://bliker.github.io/cmder/) for git and command
line usage.
Support for VS2013 (and auto picking), a Win xb script, and readme updates. This also removes the dependency on D3DX, which is only included in the DXSDK, meaning that just the Win8+ SDK should be required now.
2013-10-18 06:35:54 +00:00
#### Debugging
Adding VS2015 support.
2014-12-20 01:09:39 +00:00
VS behaves oddly with the debug paths. Open the xenia project properties
Support for VS2013 (and auto picking), a Win xb script, and readme updates. This also removes the dependency on D3DX, which is only included in the DXSDK, meaning that just the Win8+ SDK should be required now.
2013-10-18 06:35:54 +00:00
and set the 'Command' to `$(SolutionDir)$(TargetPath)` and the
'Working Directory' to `$(SolutionDir)..\..`. You can specify flags and
the file to run in the 'Command Arguments' field (or use `--flagfile=flags.txt`).
alloy-sandbox running on osx (ivm only).
2014-08-22 05:46:12 +00:00
### OSX
* Mac OSX 10.9+
* Xcode 5.1+
#### Debugging
Adding VS2015 support.
2014-12-20 01:09:39 +00:00
Choose `Product > Scheme > Edit Scheme`. For xenia, alloy-sandbox, and the
alloy-sandbox running on osx (ivm only).
2014-08-22 05:46:12 +00:00
other executables select the Run action on the left and set
`Options > Working Directory` to your root xenia/ git path.
Updating building docs.
2013-02-24 19:44:10 +00:00
## xenia-build
A simple build script is included to manage basic tasks such as building
dependencies.
./xenia-build.py --help
Support for VS2013 (and auto picking), a Win xb script, and readme updates. This also removes the dependency on D3DX, which is only included in the DXSDK, meaning that just the Win8+ SDK should be required now.
2013-10-18 06:35:54 +00:00
On Windows the `xb.bat` file enables you to issue all commands by just typing
`xb`. Note that you should run everything from the root `xenia\` folder.
On Linux/OSX the `xeniarc` bash file has some aliases that save some
keypresses:
Updating building docs.
2013-02-24 19:44:10 +00:00
source xeniarc
xb -> python xenia-build.py
xbb -> python xenia-build.py build
xbc -> python xenia-build.py clean
### Commands
#### setup
Style guide notes.
2014-07-12 01:49:49 +00:00
Run this on initial checkout to pull down all dependencies and submodules.
Updating building docs.
2013-02-24 19:44:10 +00:00
xb setup
#### pull
Does a `git pull` in addition to updating submodules and rebuilding dependencies
and gyp outputs. Use this, if possible, instead of git pull.
xb pull
#### gyp
Updates all of the supported gyp projects. If you're using Visual Studio or
Xcode to build or debug your projects you'll need to run this after you change
gyp/gypi files.
xb gyp
#### build
Builds all xenia targets using ninja. Release is built by default; specify
`--debug` to build the debug configuration.
xb build
xb build --debug
#### clean
Cleans just xenia outputs from the build/ directory. A following build will just
have the rebuild xenia and not all of the dependencies.
xb clean
#### nuke
Cleans up xenia outputs as well as all dependencies. A full build will be
Removing LLVM submodule and build information. Code is still present until transitioned over to libjit.
2013-05-19 16:29:22 +00:00
required after this so only do this if you want to reclaim your disk space or
something is really wrong.
Updating building docs.
2013-02-24 19:44:10 +00:00
xb nuke
## Running
Use the wrapper shell scripts under `bin/` to run tools. They will ensure the
tools are built (but not that they are up to date) before running and allow
switching between the debug and release variants with `--debug`.
Support for VS2013 (and auto picking), a Win xb script, and readme updates. This also removes the dependency on D3DX, which is only included in the DXSDK, meaning that just the Win8+ SDK should be required now.
2013-10-18 06:35:54 +00:00
To make life easier you can use `--flagfile=myflags.txt` to specify all
arguments, including using `--target=my.xex` to pick an executable.
Adding VS2015 support.
2014-12-20 01:09:39 +00:00
### xenia
Updating building docs.
2013-02-24 19:44:10 +00:00
Runs a xex.
Adding VS2015 support.
2014-12-20 01:09:39 +00:00
./bin/xenia some.xex