diff --git a/.github/README.md b/.github/README.md index 37e4a72..11945a4 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,33 +1,62 @@

- -

- +

-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

- - + +

Copyright @ 2019-2022 - The dahliaOS Authors - contact@dahliaos.io