tuist/README.md

<p align="center">
  <img src="https://github.com/xcbuddy/xcbuddy/raw/master/assets/logo.png" width="250" align="center"/>
  <br/><br/>
</p>

[![The MIT License](https://img.shields.io/badge/license-MIT-orange.svg?style=flat-square)](http://opensource.org/licenses/MIT)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/xcbuddy)
[![CircleCI](https://circleci.com/gh/xcbuddy/xcbuddy.svg?style=svg)](https://circleci.com/gh/xcbuddy/xcbuddy)
[![codecov](https://codecov.io/gh/xcbuddy/xcbuddy/branch/master/graph/badge.svg)](https://codecov.io/gh/xcbuddy/xcbuddy)

## Features

* 🥘 100% open source and written in Swift.
* 🐦 Type-safe Swift manifests editable with Xcode.
* ↗️ Local dependencies support.
* ⚠️ Misconfiguration catching.
* 📦 Precompiled binaries _(Frameworks & Libraries support)_.
* 🎉 CocoaPods support.
* 💻 CLI and macOS application.
* 🔄 Circular dependency detection.

## Install

Just run this command on your terminal:

```
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/xcbuddy/xcbuddy/master/scripts/install)"
```

## Setup for development

1.  Git clone: `git@github.com:xcbuddy/xcbuddy.git`
2.  Generate SPM project `swift package generate-xcodeproj`.
3.  Open `xcbuddy.xcworkspace`.
4.  Have fun 🤖

## Documentation

If you would like to contribute to the project, we recommend you to check out the [project documentation](https://xcbuddy.github.io/xcbuddy/) generated using [Jazzy](https://github.com/realm/jazzy).

## References

* [SwiftGraph](https://github.com/davecom/SwiftGraph)