Skip to content

Commit

Permalink
Making a proposal for readability (#182)
Browse files Browse the repository at this point in the history
I am making this pull request to help the readability of this document.

Please see the attached screenshots for before and after.

**Before**


![image](https://github.com/BasedHardware/Friend/assets/1120465/e5a2a0fa-e64d-4123-b333-6f340891c2ae)

**After**


![image](https://github.com/BasedHardware/Friend/assets/1120465/fc7e5a42-f653-4f42-8f03-d75c58d377f4)

I have tested locally to ensure that there are no breaking changes to
the page.
  • Loading branch information
francip authored May 24, 2024
2 parents 2d8851e + 92b2b0e commit 51f1132
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/_get_started/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ Follow these steps to get started with your Friend.
### Install the app

1. Clone the repo `git clone https://github.com/BasedHardware/friend.git`
2. Choose which version of the app you want to install (see Structure).
- Don't have the device? run `cd apps/AppStandalone` in terminal
- Have the device/NRF Board? run `cd apps/AppWithWearable` in terminal
2. Choose which version of the app you want to install (see Structure):
- Don't have the device? Run `cd apps/AppStandalone` in terminal.
- Have the device/NRF Board? Run `cd apps/AppWithWearable` in terminal.
3. Install [Flutter](https://docs.flutter.dev/get-started/install/macos/mobile-ios?tab=download) and [CocoaPods](https://guides.cocoapods.org/using/getting-started.html)
4. Install your environment variables
- For AppStandalone, update variables in in .env.template file
- For AppWithWearable, you can set the api keys needed on the mobile App from the settings page itself

6. iOS: [Install XCode](https://apps.apple.com/us/app/xcode/id497799835?mt=12) then navigate to the iOS folder. You might need to launch Xcode to select a team and specify a bundle identifier.
Android: Download/install [android Studio ](https://developer.android.com/studio) then navigate to the Android folder
Don't run in web/simulator: Bluetooth will not work
7. Run `flutter clean ` then `flutter pub get` then `pod install`
8. When everything is installed, run `flutter run `, this should run your app on a selected device
4. Install your environment variables:
- For **AppStandalone**, update variables in in .env.template file
- For **AppWithWearable**, you can set the api keys needed on the mobile App from the settings page itself
5. Build targets:
- iOS: Download/install [XCode](https://apps.apple.com/us/app/xcode/id497799835?mt=12) then navigate to the iOS folder. You might need to launch Xcode to select a team and specify a bundle identifier.
- Android: Download/install [Android Studio](https://developer.android.com/studio) then navigate to the Android folder.
- Web/Simulator: Do not run in the web/simulator as Bluetooth will not work.
6. Run `flutter clean ` then `flutter pub get` then `pod install`.
7. When everything is installed, run `flutter run `, this should run your app on the selected device (iOS or Android).

[Next Step: Buying Guide →](https://basedhardware.github.io/Friend/assembly/Buying_Guide/){: .btn .btn-purple }

0 comments on commit 51f1132

Please sign in to comment.