From 8ffff2bfaff850737aa32824897c244b95d55c60 Mon Sep 17 00:00:00 2001 From: Emil Sjolander Date: Mon, 25 Jul 2016 09:41:00 -0700 Subject: [PATCH] update readme Summary: Update readme with info about building and github markdown syntax Differential Revision: D3613284 fbshipit-source-id: 1f57009ccf02a48fe100f675ce08503e15cb6c22 --- README => README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) rename README => README.md (60%) diff --git a/README b/README.md similarity index 60% rename from README rename to README.md index 9fbacf65..8eea5ba1 100644 --- a/README +++ b/README.md @@ -1,5 +1,5 @@ -# CSSLayout [![Build Status](https://travis-ci.org/facebook/css-layout.svg?branch=master)](https://travis-ci.org/facebook/css-layout) - +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. ``` @@ -7,3 +7,7 @@ css-layout is currently in the process of big changes. If you are looking at usi 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.