Skip to content

Commit

Permalink
feat: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SincerelyFaust authored Aug 20, 2022
1 parent 82b364e commit ab248e7
Showing 1 changed file with 43 additions and 14 deletions.
57 changes: 43 additions & 14 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,56 @@
<p align="center">
<img width="30%" src="https://raw.githubusercontent.com/dahliaOS/brand/master/dahliaOS/svg/logotypewhitetext.svg#gh-dark-mode-only"

<img width="90%" src="https://raw.githubusercontent.com/dahliaOS/website/main/public/images/darkFiles.webp#gh-dark-mode-only"
</p>

<p align="center">
<img width="30%" src="https://github.com/dahliaOS/brand/blob/master/dahliaOS/svg/logotypeblacktext.svg#gh-light-mode-only"

<img width="90%" src="https://raw.githubusercontent.com/dahliaOS/website/main/public/images/lightFiles.webp#gh-light-mode-only"
</p>

<p align="center">
<a href="https://dahliaos.io">Website</a> ●
<a href="https://discord.gg/7qVbJHR">Discord</a> ●
<a href="https://github.com/dahliaos/releases/releases">Releases</a> ●
<a href="https://paypal.me/officialdahliaos">Donate</a> ●
<a href="https://github.com/dahliaos/documentation">Documentation</a>
<a href="https://dahliaos.io">Website</a> •
<a href="https://dahliaos.io/discord">Discord</a> •
<a href="https://dahliaos.io/download">Releases</a> •
<a href="https://dahliaos.io/donate">Donate</a> •
<a href="https://docs.dahliaos.io">Documentation</a>

# 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

Expand Down

0 comments on commit ab248e7

Please sign in to comment.