README.md in teapot-1.0.0.pre.rc10 vs README.md in teapot-1.0.0
- old
+ new
@@ -1,6 +1,6 @@
-# Teapot
+# 
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.
@@ -21,11 +21,11 @@
Teapot doesn't have a centralised package management system. As such, this example shows how to use an existing open source framework.
Firstly, create your project by running:
- $ teapot create "My Project" https://github.com/dream-framework project
+ $ teapot create "My Project" https://github.com/kurocha project
$ cd my-project
You will be asked to merge the project file. At present, merge tools are not very good and thus you may need to take a moment to review the changes. You want to keep most of the original file, but you would like to add the `define_target` blocks which are being added.
In the resulting project directory that has been created, you can see the list of dependencies:
@@ -45,16 +45,16 @@
### Example: Compiling TaggedFormat
For Linux (requires `clang-3.2` and `libstdc++-4.8`):
- $ teapot create "Local Tagged Format" https://github.com/dream-framework platform-linux variants tagged-format
+ $ teapot create "Local Tagged Format" https://github.com/kurocha platform-linux variants tagged-format
$ cd local-tagged-format
$ teapot build Library/TaggedFormat variant-debug
For Mac OS X (requires Xcode Command Line Tools):
- $ teapot create "Local Tagged Format" https://github.com/dream-framework platform-darwin-osx variants tagged-format
+ $ teapot create "Local Tagged Format" https://github.com/kurocha platform-darwin-osx variants tagged-format
$ cd local-tagged-format
$ teapot build Library/TaggedFormat variant-debug
You need to make sure any basic tools, e.g. compilers, system libraries, are installed correctly before building. Consult the platform and library documentation for any dependencies.