From ab248e73c2020a87e944a128aae779fdb2a8985b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marin=20He=C4=91e=C5=A1?= <44751736+SincerelyFaust@users.noreply.github.com> Date: Sat, 20 Aug 2022 12:59:09 +0200 Subject: [PATCH 1/3] feat: improve readme --- .github/README.md | 57 +++++++++++++++++++++++++++++++++++------------ 1 file changed, 43 insertions(+), 14 deletions(-) diff --git a/.github/README.md b/.github/README.md index 37e4a72..64334dc 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,27 +1,56 @@
- -
- +
-Website ● -Discord ● -Releases ● -Donate ● -Documentation +Website • +Discord • +Releases • +Donate • +Documentation + +# File manager +![GitHub Issues](https://img.shields.io/github/issues/dahliaos/files?color=brightgreen) +![License](https://img.shields.io/github/license/dahliaos/files?color=brightgreen) + +- **File manager** for dahliaOS +- **Written** in Dart/Flutter + +## Development + +To develop and locally test the application: + +### Step 1. Install development tools + +1. Install [Flutter](https://docs.flutter.dev/get-started/install) +2. Install an IDE of your choice (we recommend [VSCode](https://code.visualstudio.com/)) + * We also recommend installing Dart and Flutter extensions if you're opting in for VSCode. + For other IDEs, please inform yourself. + +### Step 2. Install dependencies + +Install pub dependencies required to run the application by running: + +```dart +flutter pub get +``` + +### Step 3. Run the application + +Run the application in an enviroment of your choice by running: -# File manager application +```dart +flutter run +``` -- File manager for dahliaOS -- Written in Flutter +Flutter has hot reloading so no need to restart the instance when it's running! ## Contribute -If you're interested in contributing to the project, please refer to [CONTRIBUTING.md](../CONTRIBUTING.md) +If you're wondering how to contribute to the project, please refer to [CONTRIBUTING.md](CONTRIBUTING.md) ## License From 817263b153b8299ec34bd5d7fa8848af4dd02faa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marin=20He=C4=91e=C5=A1?= <44751736+SincerelyFaust@users.noreply.github.com> Date: Sat, 20 Aug 2022 13:04:38 +0200 Subject: [PATCH 2/3] fix: wrong image links --- .github/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index 64334dc..7c08a2c 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,8 +1,8 @@
-
-
From 14e8774f8eceef5e6dcd5273db166af232fc390e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marin=20He=C4=91e=C5=A1?= <44751736+SincerelyFaust@users.noreply.github.com> Date: Sun, 21 Aug 2022 20:27:34 +0200 Subject: [PATCH 3/3] feat: update logo --- .github/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/README.md b/.github/README.md index 7c08a2c..11945a4 100644 --- a/.github/README.md +++ b/.github/README.md @@ -55,8 +55,8 @@ If you're wondering how to contribute to the project, please refer to [CONTRIBUT ## License
- - + +
Copyright @ 2019-2022 - The dahliaOS Authors - contact@dahliaos.io