jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make documentation xplat aware (#572)

Browse Source 
Summary:
Update the docs to include Windows and Linux.
Pull Request resolved: https://github.com/facebook/flipper/pull/572

Test Plan: eyes

Reviewed By: jknoxville

Differential Revision: D17738803

Pulled By: passy

fbshipit-source-id: 8e556fb6b3e57de6f3334286e83a59a48dbdd982
This commit is contained in:
Pascal Hartig
2019-10-04 08:16:08 -07:00
committed by Facebook Github Bot
parent 0ba47d9a71
commit a3f7e6aa59
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/getting-started.md
View File

@@ -5,7 +5,7 @@ title: Getting Started
Flipper helps you debug Android and iOS apps running in an emulator/simulator or connected physical development devices. Flipper consists of two parts:
- The desktop app for macOS
- The desktop app
- The native mobile SDKs for Android and iOS
To use Flipper, you need to add the mobile SDK to your app.
@@ -14,7 +14,7 @@ To use Flipper, you need to add the mobile SDK to your app.
### Desktop app
The desktop part of Flipper doesn't need any particular setup. Simply [download the latest build](https://www.facebook.com/fbflipper/public/mac) of our app and launch it. The desktop app is available for macOS and requires a working installation of the Android/iOS development tools on your system.
The desktop part of Flipper doesn't need any particular setup. Simply download the latest build for [Mac](https://www.facebook.com/fbflipper/public/mac), [Linux](https://www.facebook.com/fbflipper/public/linux) or [Windows](https://www.facebook.com/fbflipper/public/windows) and launch it. In order to work properly, Flipper requires a working installation of the Android and (if where applicable) iOS development tools on your system, as well as the [OpenSSL](https://www.openssl.org) binary on your `$PATH`.
Once you start Flipper and launch an emulator/simulator or connect a device, you will already be able to see the device logs in Flipper. To see app specific data, you need to integrate our native SDKs with your app.

2
docs/troubleshooting.md
View File

@@ -8,7 +8,7 @@ We hope that flipper works well out of the box, but the software is a work in pr
## Mac Desktop app
### Flipper won't launch
### Flipper won't launch on Mac
* If the window is appearing, try opening the Chrome DevTools within Flipper. To do so, from the View menu select Toggle Developer Tools or press CMD+Option+I and check if there are any errors on the console.
* Launch Flipper from the command line using `/Applications/Flipper.app/Contents/MacOS/Flipper`. This should give you some logs, that might be helpful when debugging.