README.md in teapot-0.6.0 vs README.md in teapot-0.7.0
- old
+ new
@@ -1,72 +1,44 @@
# Teapot
-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.
+Teapot is a decentralised build tool for managing complex cross-platform projects. It has many goals but it is primarily designed to improve the experience for developers trying to make cross-platform applications and libraries with a minimum of overhead.
+- Provide useful feedback when dependencies are not met or errors are encountered.
+- Decentralised dependency management allows use within private organisations without exposing code.
+- Generators can simplify the construction of new projects as well as assist with the development of existing ones.
+- The build subsystem provides a simple set of canonical operations for building libraries and executables to minimise configuration overhead.
+
[](http://travis-ci.org/ioquatix/teapot)
## Installation
-Add this line to your application's Gemfile:
+Ensure that you already have a working install of Ruby 1.9.3+
- gem 'teapot'
-
-And then execute:
-
- $ bundle
-
-Or install it yourself as:
-
$ gem install teapot
## Usage
-Create a Teapot file in the root directory of your project:
+Teapot doesn't have a centralised package management system. As such, this example shows how to use an existing open source framework.
- source "https://github.com/infusions"
+Firstly, create your project by running:
- host /linux/ do
- platform "linux"
- end
-
- host /darwin/ do
- platform "darwin-osx"
- end
+ $ teapot init "My Project" https://github.com/dream-framework project
+ $ cd my-project
- package "png"
- package "freetype"
- package "vorbis"
- package "ogg"
- package "jpeg"
+In the resulting project directory that has been created, you can see the list of dependencies:
-Then run
+ $ teapot list
- $ teapot install
+To build your project:
-This will download and compile all the selected packages into the `build` directory.
+ $ teapot build Application/MyProject variant-debug
-### CMake ###
+When you build, you need to specify dependencies. If you haven't specified all dependencies, they will be suggested to you.
-To use these packages in a CMake project, update your `CMakeLists.txt`:
+The resulting libraries will be framework dependent, but are typically located in
- 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"
+ $ cd teapot/$PROJECT_NAME/platforms/$PLATFORM_NAME/bin/
+ $ ./$PROJECT_NAME
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)