Skip to content

Commit

Permalink
Change document format
Browse files Browse the repository at this point in the history
  • Loading branch information
psychs committed Aug 7, 2012
1 parent 190f575 commit e6fd2b1
Showing 1 changed file with 12 additions and 11 deletions.
23 changes: 12 additions & 11 deletions readme.txt → README.md
@@ -1,10 +1,9 @@

* What is CocoaOniguruma
# CocoaOniguruma

CocoaOniguruma is an Objective-C binding of Oniguruma regular expression engine.
It's simple and tiny compared to the other bindings.

* How to use
## How to use

CocoaOniguruma is provided as assorted source files primarily.
Follow the steps to use CocoaOniguruma in your project.
Expand All @@ -15,7 +14,7 @@ Follow the steps to use CocoaOniguruma in your project.
4. Import the header file, so you can use CocoaOniguruma.
#import "OnigRegexp.h"

* How to use as a Framework
## How to use as a Framework

1. Open CocoaOniguruma.xcodeproj by Xcode.
2. Select "CocoaOniguruma" for Active Target and "Release" for Active Build Configuration.
Expand All @@ -29,22 +28,23 @@ Follow the steps to use CocoaOniguruma in your project.
10. Import the header file, so you can use CocoaOniguruma.
#import "CocoaOniguruma/OnigRegexp.h"

* The Author
## The Author

Satoshi Nakagawa <psychs AT limechat DOT net>
http://limechat.net/psychs/
#limechat on irc.freenode.net
* Satoshi Nakagawa http://github.com/psychs
* http://limechat.net/psychs/
* #limechat on irc.freenode.net

* Thanks
## Thanks

The specifications and implementations of split and replace functions are based on ruby.
Thanks to Matz.

* License
## License

CocoaOniguruma contains a part of Oniguruma 5.9.2 source code currently.
See also the Oniguruma's COPYING file.

<pre>
The New BSD License

Copyright (c) 2008-2011 Satoshi Nakagawa <psychs AT limechat DOT net>
Expand All @@ -69,4 +69,5 @@ OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
SUCH DAMAGE.
</pre>

0 comments on commit e6fd2b1

Please sign in to comment.