docs: update instructions for running the example app

callstack · Feb 19, 2019 · 7a4966d · 7a4966d
1 parent c108aaf
commit 7a4966d
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 6 deletions.
diff --git a/docs/pages/2.getting-started.md → docs/pages/1.getting-started.md b/docs/pages/2.getting-started.md → docs/pages/1.getting-started.md
@@ -2,6 +2,8 @@
 title: Getting Started
 ---
 
+# Getting Started
+
 ## Installation
 
 Open a Terminal in your project's folder and run,

diff --git a/docs/pages/3.theming.md → docs/pages/2.theming.md b/docs/pages/3.theming.md → docs/pages/2.theming.md
@@ -2,6 +2,8 @@
 title: Theming
 ---
 
+# Theming
+
 ## Applying a theme to the whole app
 
 To support custom themes, paper exports a `Provider` component. You need to wrap your root component with the provider to be able to support themes.

diff --git a/docs/pages/4.icons.mdx → docs/pages/3.icons.mdx b/docs/pages/4.icons.mdx → docs/pages/3.icons.mdx
@@ -4,6 +4,8 @@ export const meta = {
 
 import IconsList from './src/components/IconsList.js'
 
+# Icons
+
 ## Configuring icons
 
 Many of the components require the [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons) library to render correctly. If you're using Expo, you don't need to do anything extra, but if it's vanilla React Native project, you need link the library as described in the getting started guide.

diff --git a/docs/pages/5.react-native-web.md → docs/pages/4.react-native-web.md b/docs/pages/5.react-native-web.md → docs/pages/4.react-native-web.md
@@ -2,6 +2,8 @@
 title: Using on the Web
 ---
 
+# Using on the Web
+
 ## Pre-requisites
 
 Make sure that you have followed the getting started guide and have `react-native-paper` installed and configured before following this guide.

diff --git a/docs/pages/1.showcase.js → docs/pages/5.showcase.js b/docs/pages/1.showcase.js → docs/pages/5.showcase.js
diff --git a/example/README.md b/example/README.md
@@ -6,15 +6,13 @@ You can run the React Native app with [this Snack](https://snack.expo.io/@satya1
 
 If you want to run the example from the repo,
 
-- Clone the repository and `cd` to this directory
-- Run `yarn` to install the dependencies
-- Run `yarn start` to start the packager
+- Clone the repository and run `yarn bootstrap` in the root
+- Run `yarn example start` to start the packager
 - Follow the instructions to open it with the [Expo app](https://expo.io/)
 
 ## Web App
 
 You can also run the example app as a web app using [react-native-web](https://github.com/necolas/react-native-web),
 
-- Clone the repository and `cd` to this directory
-- Run `yarn` to install the dependencies
-- Run `yarn web` to start the webpack server and open the app in your browser
+- Clone the repository and run `yarn bootstrap` in the root
+- Run `yarn example web` to start the webpack server and open the app in your browser
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,6 +4,8 @@ export const meta = { @@
     import IconsList from './src/components/IconsList.js'
+    # Icons
     ## Configuring icons
     Many of the components require the [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons) library to render correctly. If you're using Expo, you don't need to do anything extra, but if it's vanilla React Native project, you need link the library as described in the getting started guide.
@@ Expand Down @@