update readme

Summary: Update readme with info about building and github markdown syntax

Differential Revision: D3613284

fbshipit-source-id: 1f57009ccf02a48fe100f675ce08503e15cb6c22
This commit is contained in:
Emil Sjolander
2016-07-25 09:41:00 -07:00
committed by Facebook Github Bot
parent fdd8552c4e
commit 8ffff2bfaf

13
README.md Normal file
View File

@@ -0,0 +1,13 @@
CSSLayout [![Build Status](https://travis-ci.org/facebook/css-layout.svg?branch=master)](https://travis-ci.org/facebook/css-layout)
====================================================================================================
```
css-layout is currently in the process of big changes. If you are looking at using the latest stable version please have a look at the `deprecated` branch. This includes a js version and a C-sharp version not currently available on master.
```
CSSLayout is a cross platform implementation of the flexbox specification. CSSLayout targets native mobile development and is therefor disconnected from the web browser. CSSLayout is implemented in C for portability reasons and uses JNI to expose public methods to Java.
See CSSLayout/CSSLayout.h for a look at the public API being exposed.
Building
--------
CSSLayout builds with buck (buckbuild.com). To build run `buck build //:CSSLayout` and run `buck test //:CSSLayout` to run the test suite.