Skip to content

Commit ab248e7

Browse files
feat: improve readme
1 parent 82b364e commit ab248e7

File tree

1 file changed

+43
-14
lines changed

1 file changed

+43
-14
lines changed

.github/README.md

Lines changed: 43 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,56 @@
11
<p align="center">
2-
<img width="30%" src="https://raw.githubusercontent.com/dahliaOS/brand/master/dahliaOS/svg/logotypewhitetext.svg#gh-dark-mode-only"
3-
2+
<img width="90%" src="https://raw.githubusercontent.com/dahliaOS/website/main/public/images/darkFiles.webp#gh-dark-mode-only"
43
</p>
5-
64
<p align="center">
7-
<img width="30%" src="https://github.com/dahliaOS/brand/blob/master/dahliaOS/svg/logotypeblacktext.svg#gh-light-mode-only"
8-
5+
<img width="90%" src="https://raw.githubusercontent.com/dahliaOS/website/main/public/images/lightFiles.webp#gh-light-mode-only"
96
</p>
7+
108
<p align="center">
11-
<a href="https://dahliaos.io">Website</a> ●
12-
<a href="https://discord.gg/7qVbJHR">Discord</a> ●
13-
<a href="https://github.com/dahliaos/releases/releases">Releases</a> ●
14-
<a href="https://paypal.me/officialdahliaos">Donate</a> ●
15-
<a href="https://github.com/dahliaos/documentation">Documentation</a>
9+
<a href="https://dahliaos.io">Website</a> •
10+
<a href="https://dahliaos.io/discord">Discord</a> •
11+
<a href="https://dahliaos.io/download">Releases</a> •
12+
<a href="https://dahliaos.io/donate">Donate</a> •
13+
<a href="https://docs.dahliaos.io">Documentation</a>
14+
15+
# File manager
16+
![GitHub Issues](https://img.shields.io/github/issues/dahliaos/files?color=brightgreen)
17+
![License](https://img.shields.io/github/license/dahliaos/files?color=brightgreen)
18+
19+
- **File manager** for dahliaOS
20+
- **Written** in Dart/Flutter
21+
22+
## Development
23+
24+
To develop and locally test the application:
25+
26+
### Step 1. Install development tools
27+
28+
1. Install [Flutter](https://docs.flutter.dev/get-started/install)
29+
2. Install an IDE of your choice (we recommend [VSCode](https://code.visualstudio.com/))
30+
* We also recommend installing Dart and Flutter extensions if you're opting in for VSCode.
31+
For other IDEs, please inform yourself.
32+
33+
### Step 2. Install dependencies
34+
35+
Install pub dependencies required to run the application by running:
36+
37+
```dart
38+
flutter pub get
39+
```
40+
41+
### Step 3. Run the application
42+
43+
Run the application in an enviroment of your choice by running:
1644

17-
# File manager application
45+
```dart
46+
flutter run
47+
```
1848

19-
- File manager for dahliaOS
20-
- Written in Flutter
49+
Flutter has hot reloading so no need to restart the instance when it's running!
2150

2251
## Contribute
2352

24-
If you're interested in contributing to the project, please refer to [CONTRIBUTING.md](../CONTRIBUTING.md)
53+
If you're wondering how to contribute to the project, please refer to [CONTRIBUTING.md](CONTRIBUTING.md)
2554

2655
## License
2756

0 commit comments

Comments
 (0)