Skip to content

Commit acc1fc1

Browse files
author
Abdullah Al Zawad
authored
A better and user friendly read me!
1 parent db34916 commit acc1fc1

File tree

1 file changed

+69
-34
lines changed

1 file changed

+69
-34
lines changed

.github/README.md

Lines changed: 69 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,88 @@
1+
# Files
2+
13
<p align="center">
2-
<img alt="Files hero image" src="./assets/ReadmeHero.png" />
4+
<img alt="Files hero image" src="./assets/ReadmeHero.png" width="80%" />
35
</p>
46

57
<p align="center">
6-
<a style="text-decoration:none" href="https://files.community/">
7-
<img src="https://img.shields.io/badge/Files-Website-F9B81F" alt="Files Website" /></a>
8-
<a style="text-decoration:none" href="https://github.com/files-community/Files/actions/workflows/ci.yml">
9-
<img src="https://github.com/files-community/Files/actions/workflows/ci.yml/badge.svg" alt="Files CI Status" /></a>
10-
<a style="text-decoration:none" href="https://crowdin.com/project/files-app">
11-
<img src="https://badges.crowdin.net/files-app/localized.svg" alt="Files Localization Status" /></a>
12-
<a style="text-decoration:none" href="https://discord.gg/files">
13-
<img src="https://img.shields.io/discord/725513575971684472?label=Discord&color=7289da" alt="Files Discord" /></a>
8+
<a href="https://files.community/" style="text-decoration:none">
9+
<img src="https://img.shields.io/badge/Files-Website-F9B81F" alt="Files Website" />
10+
</a>
11+
<a href="https://github.com/files-community/Files/actions/workflows/ci.yml" style="text-decoration:none">
12+
<img src="https://github.com/files-community/Files/actions/workflows/ci.yml/badge.svg" alt="Files CI Status" />
13+
</a>
14+
<a href="https://crowdin.com/project/files-app" style="text-decoration:none">
15+
<img src="https://badges.crowdin.net/files-app/localized.svg" alt="Files Localization Status" />
16+
</a>
17+
<a href="https://discord.gg/files" style="text-decoration:none">
18+
<img src="https://img.shields.io/discord/725513575971684472?label=Discord&color=7289da" alt="Files Discord" />
19+
</a>
1420
</p>
1521

16-
Files is a modern file manager that helps users organize their files and folders. Our mission with Files is to build the best file manager for Windows, and we’re proud to be building it out in the open so everyone can participate. User feedback helps shape the features we work on, & the bug reports on GitHub help to make Files more reliable. Built and maintained by the open-source community, Files features robust multitasking experiences, file tags, deep integrations, and an intuitive design.
22+
## 🚀 Introduction
23+
24+
Files is a modern, open-source file manager designed to enhance the way you organize and interact with your files and folders on Windows. Our mission is to create the best file management experience possible, and we're doing it with the help of our passionate community.
25+
26+
### Key Features
27+
28+
- 📂 Intuitive and modern design
29+
- 🏷️ File tagging system
30+
- 🔄 Robust multitasking capabilities
31+
- 🔗 Deep system integrations
32+
- 🌐 Community-driven development
1733

18-
## Installing and running Files
34+
## 📥 Installation
35+
36+
Files is available through multiple channels to suit your preferences:
37+
38+
<p align="center">
39+
<a href="https://apps.microsoft.com/detail/9NGHP3DX8HDX?launch=true&mode=full" style="text-decoration:none">
40+
<img src="./assets/StoreBadge-light.png" width="200" alt="Get Files from Microsoft Store" />
41+
</a>
42+
&nbsp;&nbsp;
43+
<a href="https://files.community/appinstallers/Files.stable.appinstaller" style="text-decoration:none">
44+
<img src="./assets/ClassicInstallerBadge-light.png" width="200" alt="Download Classic Installer" />
45+
</a>
46+
</p>
1947

20-
Files is a community-driven project that depends on your support to grow and improve. Please consider purchasing Files through the Microsoft Store or supporting us on GitHub if you use the classic installer.
48+
> 💡 **Tip:** You can install the preview version alongside the stable release to get early access to new features and improvements.
2149
22-
You can also use the preview version alongside the stable release to get early access to new features and improvements.
50+
## 🛠️ Building from Source
2351

24-
<p align="left">
25-
<!-- Store Badge -->
26-
<a style="text-decoration:none" href="https://apps.microsoft.com/detail/9NGHP3DX8HDX?launch=true&mode=full">
27-
<picture>
28-
<source media="(prefers-color-scheme: light)" srcset="./assets/StoreBadge-dark.png" width="220" />
29-
<img src="./assets/StoreBadge-light.png" width="220" />
30-
</picture></a>
31-
&ensp;
32-
<!-- Classic Installer Badge -->
33-
<a style="text-decoration:none" href="https://files.community/appinstallers/Files.stable.appinstaller">
34-
<picture>
35-
<source media="(prefers-color-scheme: light)" srcset="./assets/ClassicInstallerBadge-dark.png" width="220" />
36-
<img src="./assets/ClassicInstallerBadge-light.png" width="220" />
37-
</picture></a>
52+
For developers interested in building Files from source, detailed instructions can be found in our [documentation](https://files.community/docs/contributing/building-from-source).
53+
54+
## 🤝 Contributing
55+
56+
We welcome contributions from developers of all skill levels! Here's how you can get involved:
57+
58+
1. Check out our [issue tracker](https://github.com/files-community/Files/issues) for open tasks.
59+
2. Review our [contributing guidelines](https://github.com/files-community/Files/blob/main/.github/CONTRIBUTING.md).
60+
3. Fork the repository and create a pull request with your changes.
61+
62+
Not sure where to start? Take a look at our [task board](https://github.com/orgs/files-community/projects/3/views/2), where you can filter tasks by size and priority.
63+
64+
## 📸 Screenshots
65+
66+
<p align="center">
67+
<img src="./assets/FilesScreenshot.png" width="90%" alt="Files Screenshot" />
3868
</p>
3969

40-
## Building from source
70+
## 💖 Support the Project
4171

42-
Instructions for building the source code can be found on our [documentation site](https://files.community/docs/contributing/building-from-source).
72+
Files is a community-driven project that relies on your support to grow and improve. If you find Files useful, please consider:
4373

74+
- Purchasing it through the Microsoft Store
75+
- Supporting us on GitHub
76+
- Spreading the word about Files
4477

45-
## Contributing to Files
78+
Your support helps ensure the continued development and improvement of this open-source file manager.
4679

47-
Want to contribute to this project? Let us know with an [issue](https://github.com/files-community/Files/issues) that communicates your intent to create a [pull request](https://github.com/files-community/Files/pulls). Also, view our [contributing guidelines](https://github.com/files-community/Files/blob/main/.github/CONTRIBUTING.md) to make sure you're up to date on the coding conventions.
80+
## 🌐 Connect with Us
4881

49-
Looking for a place to start? Check out the [task board](https://github.com/orgs/files-community/projects/3/views/2), where you can sort tasks by size and priority.
82+
- [Website](https://files.community/)
83+
- [Discord](https://discord.gg/files)
84+
- [GitHub](https://github.com/files-community/Files)
5085

51-
## Screenshots
86+
---
5287

53-
![Files](./assets/FilesScreenshot.png)
88+
Thank you for your interest in Files! Together, we're building the future of file management on Windows.

0 commit comments

Comments
 (0)