Valve/Proton
1
0
Fork 0
mirror of https://github.com/ValveSoftware/Proton.git synced 2024-12-26 14:45:48 +03:00
Code Issues Packages Projects Releases Wiki Activity

README: Document new top-level Makefile

Browse Source
This commit is contained in:
Andrew Eikum 2019-02-05 10:28:12 -06:00
parent 8f7f909dd4
commit f5bbcfd4b9
1 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -46,6 +46,50 @@ If you wish to change any subcomponent, now is the time to do so.
For example, if you wish make changes to Wine, you would apply those
changes to the <tt>wine/</tt> directory.
---
Easy build path
---
Building Proton is quite complicated. We now provide a top-level Makefile which
will execute most of the build commands for you. This section describes how to
use this Makefile for simple Proton builds.
This Makefile uses a virtual machine to create a consistent build environment.
The VM is managed with [Vagrant](https://www.vagrantup.com/), which you will
need to install before invoking these commands. While Vagrant supports several
VM software backends, Proton's build system has been tested only with its
VirtualBox backend. You may run into problems with the shared folder
(`vagrant_share`) and/or CPU and memory usage with other backends.
If your build VM gets cluttered, or falls out of date, you can use `vagrant
destroy` to wipe the VM clean, then invoke one of the below commands to start
over.
After checking out Proton and updating its submodules, you can use these
targets to build Proton:
`make install` - This will install Proton into your user's Steam directory.
You may need to restart the Steam client to see it. It will be called
`proton-localbuild`. Subsequent `make install` invocations will overwrite
this installation.
`make deploy` - This will create a deployment tarball and set of files which
can be distributed as a Proton package. This is what we use to deploy Proton to
Steam users. The package will be dropped into a new directory in
`vagrant_share/`, named after the nearest Git tag (see `git describe`).
We also provide targets useful for simple Wine development:
`make proton` - This will build Proton without copying its files out of the VM.
`make module=<module> module` - This will build both 32- and 64-bit versions of
the specified module, and copy the result into the `vagrant_share` directory.
This allows rapid iteration on one module. This target is only useful after
building Proton.
If you are doing significant Wine development or want to control the build with
more fine detail, see the full documentation below.
---
Building
---