diff --git a/src/README.md b/src/README.md new file mode 100644 index 000000000000..99522abf6223 --- /dev/null +++ b/src/README.md @@ -0,0 +1,33 @@ + + +# Files Source Code + +## Our goals + +Please refer to https://github.com/files-community/Files/issues/4180 for our goals. +We are actively working on refactoring, optimizing and improving performance and codebase. + +- Refactoring codebase +- Package size reduction +- Less 3rd-party dependency +- Less than 1% crash rate +- Robust file system operations +- Robust file system accessing +- Higher storage thumbnail quality +- Performance on multitasking + +## Projects + +Name|Language|Built with|Platform|Description +---|---|---|---|--- +Files.App.Package
Files.App (Package)|*None*|[WinAppSdk](https://learn.microsoft.com/windows/apps/windows-app-sdk)|Windows|Packaging project with [WAP](https://learn.microsoft.com/windows/apps/get-started/intro-pack-dep-proc) for `Files.App` project on Windows. +Files.App.BackgroundTasks|C#|[CsWinRT](https://learn.microsoft.com/windows/apps/develop/platform/csharp-winrt)|Windows|In-proc background service on Windows. +Files.App.Launcher|C++|[Win32 API](https://learn.microsoft.com/windows/win32/api)|Windows|Entry point of a process to override `Win+E` or `explorer.exe` to launch Files on Windows. +Files.App.OpenDialog|C++|[Win32 API](https://learn.microsoft.com/windows/win32/api)|Windows|Entry point of a process to override `FileOpenDialog` common dialog on Windows. +Files.App.SaveDialog|C++|[Win32 API](https://learn.microsoft.com/windows/win32/api)|Windows|Entry point of a process to override `FileSaveDialog` common dialog on Windows. +Files.App.Server|C#|[CsWinRT](https://learn.microsoft.com/windows/apps/develop/platform/csharp-winrt)|Windows|Out-of-proc background service to safely continue ongoing tasks even after foreground processes are terminated. This is interoperable between the server process and Files processes using C#/WinRT projection because it's supposed to be shared by multiple Files processes. +Files.App.Storage|C#|*None*|Windows|Implementation of Files Storage Layer on Windows. +Files.App|C#|[WinAppSdk](https://learn.microsoft.com/windows/apps/windows-app-sdk)|Windows|Entry point and UI thread of Files on Windows. +Files.Core.SourceGenerator|C#|*None*|Multi-platform|Source generators to boost developer experience for Files. +Files.Core.Storage|C#|*None*|Multi-platform|Interfaces of Files Storage Layer. +Files.Shared|C#|*None*|Multi-platform|Fundamental helpers and extensions. diff --git a/tests/README.md b/tests/README.md new file mode 100644 index 000000000000..047aa9ff8d38 --- /dev/null +++ b/tests/README.md @@ -0,0 +1,19 @@ + +# Files Tests + +## Unit tests + +Project: **Files.UnitTests** + +*Still not implemeneted yet.* + +## Interaction tests + +Project: **Files.IntegerationTests** + +Name|Description +---|--- +SessionTests|Verifies whether the application can be run. +GeneralAppTests|Verifies whether the general file management elements are accessible. +FolderCreationTests|Verifies whether a folder can be created. +AppSettingsTests|Verifies whether the application respecitive settings page are accessible.