Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 69 additions & 34 deletions .github/README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,88 @@
# Files

<p align="center">
<img alt="Files hero image" src="./assets/ReadmeHero.png" />
<img alt="Files hero image" src="./assets/ReadmeHero.png" width="80%" />
</p>

<p align="center">
<a style="text-decoration:none" href="https://files.community/">
<img src="https://img.shields.io/badge/Files-Website-F9B81F" alt="Files Website" /></a>
<a style="text-decoration:none" href="https://github.com/files-community/Files/actions/workflows/ci.yml">
<img src="https://github.com/files-community/Files/actions/workflows/ci.yml/badge.svg" alt="Files CI Status" /></a>
<a style="text-decoration:none" href="https://crowdin.com/project/files-app">
<img src="https://badges.crowdin.net/files-app/localized.svg" alt="Files Localization Status" /></a>
<a style="text-decoration:none" href="https://discord.gg/files">
<img src="https://img.shields.io/discord/725513575971684472?label=Discord&color=7289da" alt="Files Discord" /></a>
<a href="https://files.community/" style="text-decoration:none">
<img src="https://img.shields.io/badge/Files-Website-F9B81F" alt="Files Website" />
</a>
<a href="https://github.com/files-community/Files/actions/workflows/ci.yml" style="text-decoration:none">
<img src="https://github.com/files-community/Files/actions/workflows/ci.yml/badge.svg" alt="Files CI Status" />
</a>
<a href="https://crowdin.com/project/files-app" style="text-decoration:none">
<img src="https://badges.crowdin.net/files-app/localized.svg" alt="Files Localization Status" />
</a>
<a href="https://discord.gg/files" style="text-decoration:none">
<img src="https://img.shields.io/discord/725513575971684472?label=Discord&color=7289da" alt="Files Discord" />
</a>
</p>

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:

<p align="center">
<a href="https://apps.microsoft.com/detail/9NGHP3DX8HDX?launch=true&mode=full" style="text-decoration:none">
<img src="./assets/StoreBadge-light.png" width="200" alt="Get Files from Microsoft Store" />
</a>
&nbsp;&nbsp;
<a href="https://files.community/appinstallers/Files.stable.appinstaller" style="text-decoration:none">
<img src="./assets/ClassicInstallerBadge-light.png" width="200" alt="Download Classic Installer" />
</a>
</p>

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

<p align="left">
<!-- Store Badge -->
<a style="text-decoration:none" href="https://apps.microsoft.com/detail/9NGHP3DX8HDX?launch=true&mode=full">
<picture>
<source media="(prefers-color-scheme: light)" srcset="./assets/StoreBadge-dark.png" width="220" />
<img src="./assets/StoreBadge-light.png" width="220" />
</picture></a>
&ensp;
<!-- Classic Installer Badge -->
<a style="text-decoration:none" href="https://files.community/appinstallers/Files.stable.appinstaller">
<picture>
<source media="(prefers-color-scheme: light)" srcset="./assets/ClassicInstallerBadge-dark.png" width="220" />
<img src="./assets/ClassicInstallerBadge-light.png" width="220" />
</picture></a>
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

<p align="center">
<img src="./assets/FilesScreenshot.png" width="90%" alt="Files Screenshot" />
</p>

## 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.