README.md in teapot-0.0.1 vs README.md in teapot-0.0.3
- old
+ new
@@ -2,10 +2,12 @@
Teapot is a tool for managing complex cross-platform builds. It provides
advanced dependency management via the Teapot file and is supported by
the infusions ecosystem of packages and platform tooling.
+[](http://travis-ci.org/ioquatix/teapot)
+
## Installation
Add this line to your application's Gemfile:
gem 'teapot'
@@ -18,10 +20,53 @@
$ gem install teapot
## Usage
-TODO: Write usage instructions here
+Create a Teapot file in the root directory of your project:
+
+ source "https://github.com/infusions"
+
+ host /linux/ do
+ platform "linux"
+ end
+
+ host /darwin/ do
+ platform "darwin-osx"
+ end
+
+ package "png"
+ package "freetype"
+ package "vorbis"
+ package "ogg"
+ package "jpeg"
+
+Then run
+
+ $ teapot install
+
+This will download and compile all the selected packages into the `build` directory.
+
+### CMake ###
+
+To use these packages in a CMake project, update your `CMakeLists.txt`:
+
+ list(APPEND CMAKE_PREFIX_PATH "${CMAKE_SOURCE_DIR}/build/${TEAPOT_PLATFORM}/")
+
+Then configure like so:
+
+ cmake path/to/src -DTEAPOT_PLATFORM=linux
+
+### Xcode ###
+
+To use these packages in an Xcode project, creating a custom `teapot.xcconfig` is recommended:
+
+ TEAPOT_PLATFORM=darwin-osx
+ TEAPOT_PREFIX_PATH=$(SRCROOT)/build/$(TEAPOT_PLATFORM)
+
+ // Search paths:
+ HEADER_SEARCH_PATHS=$(inherited) "$(TEAPOT_PREFIX_PATH)/include"
+ LIBRARY_SEARCH_PATHS=$(inherited) "$(TEAPOT_PREFIX_PATH)/lib"
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)