Skip to content
This repository has been archived by the owner on Dec 14, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yash-ahir authored May 8, 2021
1 parent e809933 commit b4b8ad0
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ PassMan Logo © 2021 by Yash Ahir is licensed under CC BY-NC 4.0
### A simple, cross-platform password manager created with Flutter.

<a href='https://play.google.com/store/apps/details?id=com.yashahir.passman&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Get it on Google Play' src='https://play.google.com/intl/en_us/badges/static/images/badges/en_badge_web_generic.png' width='180'/></a>

---
### How to run this
- Install Flutter for your platform of choice from [here](https://flutter.dev/docs/get-started/install).
- This project uses [Moor](https://pub.dev/packages/moor) for persistent storage and as such supports [all platforms that Moor does](https://moor.simonbinder.eu/docs/platforms/). As mentioned in the supported platforms page for it, for desktop support most Linux distrubutions include a SQLite binary and MacOS will utilize the `VmDatabase` class (A Moor database that runs in a Dart VM), so no extra steps for it. For Windows or a Linux distribution without SQLite, you need to [download](https://sqlite.org/download.html) and install SQLite. Note: I might ship a pre-compiled SQLite binary for individual platform packages when I release version 1.0.0 executables for desktop release.
- For desktop support, also make sure to follow the requirements [here](https://flutter.dev/desktop).
- This project uses [Moor](https://pub.dev/packages/moor) for persistent storage and as such supports [all platforms that Moor does](https://moor.simonbinder.eu/docs/platforms/). As mentioned in the supported platforms page for it, for desktop support most Linux distrubutions include a SQLite binary and MacOS will utilize the `VmDatabase` class (A Moor database that runs in a Dart VM), so no extra steps for it. For Windows or a Linux distribution without SQLite, you need to [download](https://sqlite.org/download.html) and install SQLite. Note: I might ship a pre-compiled SQLite binary for individual platform packages when I release version 1.0.0 executables for desktop.
- For desktop development, also make sure to follow the requirements [here](https://flutter.dev/desktop).
- Clone the repository. After it is cloned `cd` into the repository directory and run `flutter run --release`. This will launch the application in release mode, if you want to utilize hot-reloading and hot-restarting for any reason, omit the `--release` flag.

---
Expand Down

0 comments on commit b4b8ad0

Please sign in to comment.