added readme and bumped version
This commit is contained in:
parent
0f9ae53d7c
commit
4432af0aee
2 changed files with 42 additions and 12 deletions
52
README.md
52
README.md
|
|
@ -1,18 +1,48 @@
|
|||
# plasmoid
|
||||
# Plasmoid
|
||||
|
||||
A new Flutter project.
|
||||
<img src="assets/plasmoid.svg" width="96" alt="Plasmoid logo">
|
||||
|
||||
## Getting Started
|
||||
A minimalist and opinionated app launcher for Android.
|
||||
|
||||
This project is a starting point for a Flutter application.
|
||||
## Screenshots
|
||||
|
||||
A few resources to get you started if this is your first Flutter project:
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><a href="screenshots/01.png" target="_blank"><img src="screenshots/01.png" width="180"></a><br><sub>Dark mode with tags</sub></td>
|
||||
<td align="center"><a href="screenshots/02.png" target="_blank"><img src="screenshots/02.png" width="180"></a><br><sub>Light mode</sub></td>
|
||||
<td align="center"><a href="screenshots/03.png" target="_blank"><img src="screenshots/03.png" width="180"></a><br><sub>Search filter</sub></td>
|
||||
<td align="center"><a href="screenshots/04.png" target="_blank"><img src="screenshots/04.png" width="180"></a><br><sub>Swipe to pin</sub></td>
|
||||
<td align="center"><a href="screenshots/05.png" target="_blank"><img src="screenshots/05.png" width="180"></a><br><sub>Tag editor</sub></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
|
||||
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
|
||||
## Features
|
||||
|
||||
For help getting started with Flutter development, view the
|
||||
[online documentation](https://docs.flutter.dev/), which offers tutorials,
|
||||
samples, guidance on mobile development, and a full API reference.
|
||||
**Search & Launch** — Start typing to filter apps by name or tag. Tap to launch immediately.
|
||||
|
||||
Vectors and icons by <a href="https://game-icons.net/?ref=svgrepo.com" target="_blank">Game Icons.net</a> in CC Attribution License via <a href="https://www.svgrepo.com/" target="_blank">SVG Repo</a>
|
||||
**Tagging** — Long-press an app and choose Edit Tags to assign tags. Tags are searchable using prefixes: `@context`, `#general`, `+project`.
|
||||
|
||||
**Gestures**
|
||||
- Swipe right to pin an app to the top (swipe right again to unpin)
|
||||
- Swipe left to demote an app to the bottom (swipe left again to restore)
|
||||
- Long-press for Edit Tags, App Info, and more
|
||||
|
||||
**Settings** — Toggle icon visibility, color mode, theme, sort order, auto-focus, status icons, and demoted app visibility from the menu.
|
||||
|
||||
## Build
|
||||
|
||||
```sh
|
||||
flutter build apk --release
|
||||
```
|
||||
|
||||
On systems without Flutter installed, [devbox](https://www.jetify.com/devbox) provides a reproducible environment:
|
||||
|
||||
```sh
|
||||
devbox install
|
||||
devbox shell
|
||||
flutter build apk --release
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Made with love by randogoth — icon by [Game Icons.net](https://game-icons.net/).
|
||||
Loading…
Add table
Add a link
Reference in a new issue