Skip to content

Simplified the readme file #7517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jan 11, 2022
Merged
Show file tree
Hide file tree
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
5 changes: 0 additions & 5 deletions .github/issue_label_bot.yaml

This file was deleted.

67 changes: 0 additions & 67 deletions .github/workflows/codeql-analysis.yml

This file was deleted.

53 changes: 33 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,48 @@
<p align="center">
<img src="src/Files/Assets/AppTiles/StoreLogo.scale-400.png" />
<img alt="Files Logo" src="src/Files/Assets/AppTiles/StoreLogo.scale-400.png" width="100px" />
<h1 align="center">Files</h1>
</p>

[![Build Status](https://dev.azure.com/filescommunity/Files/_apis/build/status/Build%20Pipeline?branchName=main)](https://dev.azure.com/filescommunity/Files/_build/latest?definitionId=4&branchName=main)
[![Discord](https://discordapp.com/api/guilds/725513575971684472/widget.png)](https://discord.gg/files)

## Welcome to the Files repository

![Files](src/Files/Assets/FilesHome.png)
<a style="text-decoration:none" href="https://www.microsoft.com/store/apps/9NGHP3DX8HDX">
<img src="https://img.shields.io/badge/Microsoft%20Store-Download-orange.svg?style=flat-square" alt="Store link" />
</a>

## What is Files?
Files is a file manager for Windows with a powerful yet intuitive design. It has features like multiple tabs, panes, columns, shell extensions in the context menu and tags.

## Where to get Files
- [Microsoft Store](https://www.microsoft.com/store/apps/9NGHP3DX8HDX)
We welcome discussions and contributions to our repository, however to help maintain a healthy community, please read our [code of conduct](https://github.com/files-community/Files/blob/main/CODE_OF_CONDUCT.md).

## Vision for Files
Our vision for Files is to be fully functional while keeping it simple and easy to use. Whether it's implementing new features, or pushing the boundaries of the platform, your input will help shape the future of Files.
## FAQ
Have any questions? Check out our [documentation site](https://files.community/docs)!

## Why should I contribute?
We can confidently assert Files is the platform's best file explorer project to bring your innovations to. We focus heavily on extensibility and code modularity and have no plans to stop doing so. When you contribute to this project, you're helping everyone by fixing reported bugs, adding new features, or correcting existing behavior. These changes are quickly included in the final product for all users to benefit from.
## Building from source

We welcome discussions and contributions to our repository, however to help maintain a healthy community, please read our [code of conduct](https://github.com/files-community/Files/blob/main/CODE_OF_CONDUCT.md).
### 1: Prerequisites

## Building Files source
- Install Visual Studio 2019 and the UWP Development Kit.
- Clone the repository and open the `Files.sln` in VS.
- Visual Studio will install all missing dependencies.
- Run the `Files.Package` project.
- [Git](https://git-scm.com)
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) with the UWP Development Kit.

View our [Contributing guidelines](https://github.com/files-community/Files/blob/main/.github/CONTRIBUTING.md)
### 2: Clone the repository.

## FAQ
Have any questions? Check out our [documentation site](https://files.community/docs)!
```ps
git clone https://github.com/files-community/Files
```

This will create a local copy of the repository.

### 3: Build the project

To build the app in development mode, open the sln file in Visual Studio (Files.sln) and set the Files.Package project as the startup item by right-clicking on `Files.Package` in the solution explorer & hitting ‘Set as Startup item’.

In the architecture pane, select the correct architecture for your system as Debug which should look like this:
![image](https://user-images.githubusercontent.com/39923744/148721296-2bd132d0-4a4d-4555-8f58-16b00b18ade3.png)

## Contributors

Want to contribute to this project? Feel free to open an [issue](/issues) or [pull request](/pulls). 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 latest guidelines for contributing to the Files codebase.

## Screenshots

![Files](src/Files/Assets/FilesHome.png)