Skip to content

Commit e42eeba

Browse files
authored
Simplified the readme file (#7517)
1 parent e72d900 commit e42eeba

File tree

3 files changed

+33
-92
lines changed

3 files changed

+33
-92
lines changed

.github/issue_label_bot.yaml

Lines changed: 0 additions & 5 deletions
This file was deleted.

.github/workflows/codeql-analysis.yml

Lines changed: 0 additions & 67 deletions
This file was deleted.

README.md

Lines changed: 33 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,48 @@
11
<p align="center">
2-
<img src="src/Files/Assets/AppTiles/StoreLogo.scale-400.png" />
2+
<img alt="Files Logo" src="src/Files/Assets/AppTiles/StoreLogo.scale-400.png" width="100px" />
3+
<h1 align="center">Files</h1>
34
</p>
45

56
[![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)
67
[![Discord](https://discordapp.com/api/guilds/725513575971684472/widget.png)](https://discord.gg/files)
7-
8-
## Welcome to the Files repository
9-
10-
![Files](src/Files/Assets/FilesHome.png)
8+
<a style="text-decoration:none" href="https://www.microsoft.com/store/apps/9NGHP3DX8HDX">
9+
<img src="https://img.shields.io/badge/Microsoft%20Store-Download-orange.svg?style=flat-square" alt="Store link" />
10+
</a>
1111

1212
## What is Files?
1313
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.
1414

15-
## Where to get Files
16-
- [Microsoft Store](https://www.microsoft.com/store/apps/9NGHP3DX8HDX)
15+
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).
1716

18-
## Vision for Files
19-
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.
17+
## FAQ
18+
Have any questions? Check out our [documentation site](https://files.community/docs)!
2019

21-
## Why should I contribute?
22-
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.
20+
## Building from source
2321

24-
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).
22+
### 1: Prerequisites
2523

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

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

34-
## FAQ
35-
Have any questions? Check out our [documentation site](https://files.community/docs)!
29+
```ps
30+
git clone https://github.com/files-community/Files
31+
```
32+
33+
This will create a local copy of the repository.
34+
35+
### 3: Build the project
36+
37+
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’.
38+
39+
In the architecture pane, select the correct architecture for your system as Debug which should look like this:
40+
![image](https://user-images.githubusercontent.com/39923744/148721296-2bd132d0-4a4d-4555-8f58-16b00b18ade3.png)
41+
42+
## Contributors
43+
44+
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.
45+
46+
## Screenshots
47+
48+
![Files](src/Files/Assets/FilesHome.png)

0 commit comments

Comments
 (0)