57fe28235a
**what is the change?:** Adding a document linking to the Facebook Open Source Code of Conduct, for visibility and to meet Github community standards. **why make this change?:** It's important that contributors can find the Code of Conduct for a project. xcbuild already links to a Code of Conduct in the Contributing guide, which is great! :) Exposing the COC via a separate markdown file is a standard being promoted by Github via the Community Profile in order to meet their Open Source Guide's recommended community standards. As you can see, adding this file will complete [xcbuild's Community Profile](https://github.com/facebook/xcbuild/community) checklist and increase the visibility of our COC. **test plan:** Viewing it on my branch - (Flarnie will insert a screenshot) **issue:** internal task t23481323 |
||
|---|---|---|
| Libraries | ||
| Specifications | ||
| ThirdParty | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| appveyor.yml | ||
| CMakeLists.txt | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| Makefile | ||
| PATENTS | ||
| README.md | ||
xcbuild
xcbuild is an Xcode-compatible build tool with the goal of providing faster builds, better documentation of the build process and running on multiple platforms (macOS, Linux, and Windows)
Why xcbuild?
| Features | Performance | ||||
|---|---|---|---|---|---|
| 🚀 | Blazing fast incremental builds | xcodebuild | xcbuild + Ninja | ||
| 📖 | Documents the Xcode build process | ||||
| 🔗 | Builds Xcode projects and workspaces | ||||
| 🐣 | Supports Swift apps and frameworks | Clean Build | 30.103s | 25.122s | |
| ✨ | Tools and libraries for Xcode projects | ||||
| 💝 | Fully compatible with xcpretty | ||||
| 🎩 | Uses Ninja and llbuild | Incremental Build | 2.190s | 0.046s ⚡ | |
| :octocat: | Open source under the BSD license | ||||
| 🐧 | Builds on Linux and Windows | ||||
xcbuild and other build tools
| xctool | Buck | xcpretty |
|---|---|---|
| xcbuild and xctool are both Xcode-compatible build systems. We plan on slowly deprecating xctool's build support but keep it as a great way to run tests. | Facebook's main build system is Buck. Buck has a stronger architecture and advanced features like artifact caching while having a much simpler build format. If you have a new project, it's highly recommended. | xcbuild works great with xcpretty. Pipe the output from xcbuild to xcpretty the same way as you would from xcodebuild. |
Building
- Xcode 7 or later, on macOS.
- GCC 4.8 or later, on Linux.
libpng16-dev,zlib1g-dev,libxml2-dev, andpkg-configare also required. - Visual Studio 2015 or later, on Windows. A
zlibDLL is also required. - CMake and Ninja (or llbuild).
- With Homebrew:
brew install cmake ninja - With Chocolatey:
choco install cmake ninja
- With Homebrew:
To build:
- All platforms:
git clone https://github.com/facebook/xcbuild
cd xcbuild
git submodule update --init
- Linux and macOS:
make
Build output will be in the build directory. Run xcbuild with ./build/xcbuild.
- Windows (experimental):
cmake -Bbuild -H. -G "Visual Studio 14 2015" -DZLIB_ROOT=<path>
Open build\xcbuild.sln and build.
Usage
The command line options are compatible with xcodebuild.
xcbuild -workspace Example.xcworkspace -scheme Example
Using Ninja (or llbuild)
To switch to the significantly faster Ninja executor:
xcbuild -executor ninja [-workspace Example.xcworkspace ...]
Besides the -executor ninja parameters, the options are otherwise identical. The Ninja executor is fastest if it can avoid re-generating the Ninja files if the build configuration and input project files do not change.
Contributing
xcbuild actively welcomes contributions from the community. If you're interested in contributing, be sure to check out the contributing guide. It includes some tips for getting started in the codebase, as well as important information about the code of conduct, license, and CLA.
Thanks
xcbuild is built on build system documentation from the community. In particular, thanks to these people for their writing:
Third-party licenses are listed in the LICENSE document.