From acc1fc1967d0691bf94cf7620449da1561fa3eb0 Mon Sep 17 00:00:00 2001 From: Abdullah Al Zawad Date: Sat, 12 Oct 2024 22:56:16 +0600 Subject: [PATCH] A better and user friendly read me! --- .github/README.md | 103 +++++++++++++++++++++++++++++++--------------- 1 file changed, 69 insertions(+), 34 deletions(-) diff --git a/.github/README.md b/.github/README.md index 1ec8850f4129..46e4b7a77ec2 100644 --- a/.github/README.md +++ b/.github/README.md @@ -1,53 +1,88 @@ +# Files +

- Files hero image + Files hero image

- - Files Website - - Files CI Status - - Files Localization Status - - Files Discord + + Files Website + + + Files CI Status + + + Files Localization Status + + + Files Discord +

-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. +## πŸš€ Introduction + +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. + +### Key Features + +- πŸ“‚ Intuitive and modern design +- 🏷️ File tagging system +- πŸ”„ Robust multitasking capabilities +- πŸ”— Deep system integrations +- 🌐 Community-driven development -## Installing and running Files +## πŸ“₯ Installation + +Files is available through multiple channels to suit your preferences: + +

+ + Get Files from Microsoft Store + +    + + Download Classic Installer + +

-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. +> πŸ’‘ **Tip:** You can install the preview version alongside the stable release to get early access to new features and improvements. -You can also use the preview version alongside the stable release to get early access to new features and improvements. +## πŸ› οΈ Building from Source -

- - - - - - -   - - - - - - +For developers interested in building Files from source, detailed instructions can be found in our [documentation](https://files.community/docs/contributing/building-from-source). + +## 🀝 Contributing + +We welcome contributions from developers of all skill levels! Here's how you can get involved: + +1. Check out our [issue tracker](https://github.com/files-community/Files/issues) for open tasks. +2. Review our [contributing guidelines](https://github.com/files-community/Files/blob/main/.github/CONTRIBUTING.md). +3. Fork the repository and create a pull request with your changes. + +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. + +## πŸ“Έ Screenshots + +

+ Files Screenshot

-## Building from source +## πŸ’– Support the Project -Instructions for building the source code can be found on our [documentation site](https://files.community/docs/contributing/building-from-source). +Files is a community-driven project that relies on your support to grow and improve. If you find Files useful, please consider: +- Purchasing it through the Microsoft Store +- Supporting us on GitHub +- Spreading the word about Files -## Contributing to Files +Your support helps ensure the continued development and improvement of this open-source file manager. -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. +## 🌐 Connect with Us -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. +- [Website](https://files.community/) +- [Discord](https://discord.gg/files) +- [GitHub](https://github.com/files-community/Files) -## Screenshots +--- -![Files](./assets/FilesScreenshot.png) +Thank you for your interest in Files! Together, we're building the future of file management on Windows.