From aba478ad1681f19f2593473abc14881b66afa539 Mon Sep 17 00:00:00 2001 From: Justin Spahr-Summers Date: Mon, 22 Oct 2012 13:28:06 -0700 Subject: [PATCH] Boilerplate README to rustle @maddox's jimmies --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7f8e0b3..9a3d268 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ -Archimedes -========== +# Archimedes -Geometry functions for Cocoa and Cocoa Touch \ No newline at end of file +Archimedes contains useful geometry functions for your Cocoa or Cocoa Touch application. + +This framework is very much a work in progress at the moment, and should be considered **alpha quality**. Breaking changes may happen often during this time. + +## Getting Started + +To start building the framework, clone this repository and then run `git submodule update --init --recursive`. This will automatically pull down any dependencies. + +## Contributing + +Fork this repository, make it awesomer (preferably in a branch named for the topic), send a pull request! + +All contributions should match our [coding conventions](https://github.com/github/objective-c-conventions). + +## License + +Archimedes is released under the MIT license. See [LICENSE.md](https://github.com/github/Archimedes/blob/master/LICENSE.md).