Update README w/TOC & link Contributing & MIT sections (#222)

Summary:
* Add a Table of Contents to README
* Link CONTRIBUTING section to CONTRIBUTING.md file
* Link License section to LICENSE file
* Change `Sonar` references to `Flipper` in CONTRIBUTING.md

![flipper-readme](https://user-images.githubusercontent.com/10098988/43982318-f201c870-9cba-11e8-90b7-ebc47854e641.gif)
Pull Request resolved: https://github.com/facebook/flipper/pull/222

Reviewed By: danielbuechele

Differential Revision: D9282868

Pulled By: passy

fbshipit-source-id: 2f1ff9b598b8a0afdde9039e5a2c4a157c48ed9c
This commit is contained in:
fvonhoven
2018-08-13 03:38:39 -07:00
committed by Facebook Github Bot
parent 4ae01fce6a
commit decde229b6
2 changed files with 27 additions and 7 deletions

View File

@@ -10,6 +10,25 @@ Flipper is a platform for debugging mobile apps on iOS and Android. Visualize, i
![Flipper](/website/static/img/splash@2x.png)
## Table of Contents
- [Mobile development](#mobile-development)
- [Extending Flipper](#extending-flipper)
- [Contributing to Flipper](#contributing-to-flipper)
- [In this repo](#in-this-repo)
- [Getting started](#getting-started)
- [Requirements](#requirements)
- [Building from Source](#building-from-source)
- [Desktop](#desktop)
- [Running from source](#running-from-source)
- [Building standalone application](#building-standalone-application)
- [iOS SDK + Sample App](#ios-sdk--sample-app)
- [Android SDK + Sample app](#android-sdk--sample-app)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Mobile development
Flipper aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools including a log viewer, interactive layout inspector, and network inspector.
@@ -86,7 +105,8 @@ Start up an android emulator and run the following in the project root:
Find the full documentation for this project at [fbflipper.com](https://fbflipper.com/docs).
## Contributing and license
## Contributing
See the [CONTRIBUTING](/CONTRIBUTING.md) file for how to help out.
See the CONTRIBUTING file for how to help out.
Flipper is MIT licensed, as found in the LICENSE file.
## License
Flipper is MIT licensed, as found in the [LICENSE](/LICENSE) file.