Skip to content

A Swiss Army knife for developers.

Renamed DevTools to DevToys and added README.MD

Etienne Baudouxff7b7ebc7cd7
diff --git a/.vsconfig b/.vsconfig
new file mode 100644
index 000000000..6ba3f91f2
--- /dev/null
+++ b/.vsconfig
@@ -0,0 +1,31 @@
+{
+ "version": "1.0",
+ "components": [
+ "Microsoft.VisualStudio.Component.CoreEditor",
+ "Microsoft.VisualStudio.Workload.CoreEditor",
+ "Microsoft.NetCore.Component.Runtime.5.0",
+ "Microsoft.NetCore.Component.Runtime.3.1",
+ "Microsoft.NetCore.Component.SDK",
+ "Microsoft.VisualStudio.Component.NuGet",
+ "Microsoft.VisualStudio.Component.Roslyn.Compiler",
+ "Microsoft.VisualStudio.Component.Roslyn.LanguageServices",
+ "Microsoft.Component.MSBuild",
+ "Microsoft.VisualStudio.Component.TextTemplating",
+ "Microsoft.VisualStudio.Component.SQL.CLR",
+ "Microsoft.Net.Component.4.5.TargetingPack",
+ "Microsoft.VisualStudio.Component.DiagnosticTools",
+ "Microsoft.VisualStudio.Component.AppInsights.Tools",
+ "Microsoft.VisualStudio.Component.IntelliCode",
+ "Microsoft.VisualStudio.Component.Windows10SDK.19041",
+ "Microsoft.ComponentGroup.Blend",
+ "Microsoft.VisualStudio.ComponentGroup.MSIX.Packaging",
+ "Microsoft.Component.NetFX.Native",
+ "Microsoft.VisualStudio.ComponentGroup.UWP.NetCoreAndStandard",
+ "Microsoft.VisualStudio.Component.Graphics",
+ "Microsoft.VisualStudio.ComponentGroup.UWP.Xamarin",
+ "Microsoft.VisualStudio.ComponentGroup.UWP.Support",
+ "Microsoft.VisualStudio.Workload.Universal",
+ "Component.GitHub.VisualStudio",
+ "Microsoft.VisualStudio.Component.Git"
+ ]
+}
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 000000000..dbfa588bb
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,77 @@
+# How to Contribute:
+
+You can contribute to DevToys app by:
+- Report issues and bugs [here](//TODO)
+- Submit feature requests [here](//TODO)
+- Create a pull request to helps:
+ * Fix an existing bug, prefix title with `[FIX] `.
+ * Implement new features, prefix title with `[FEATURE] `.
+ * Fix grammar errors or improve my documentations, prefix title with `[DOC] `.
+ * Improve CI/CD pipeline, prefix title with `[CI] `.
+ * Cleanup code and code refactoring or anything else you want to change in the project not listed above, prefix title with `[OTHER] ` or assign a custom prefix with the same format (`[LABEL] `).
+- Internationalization and localization:
+ * //TODO: Explain how
+
+# How to Build and Run DevToys from source
+
+* Make sure your machine is running on Windows 10 1903+.
+* Make sure you have Visual Studio 2019 16.10+ installed.
+* In Visual Studio Installer, install the required components by importing the `.vsconfig` file from the root of the repository.
+* Run `init.ps1` in a PowerShell command prompt to restore all the dependencies.
+* Open `src/DevTools.sln` with Visual Studio and set Solution Platform to x64(amd64)*.
+* Once opened, set `src/dev/startup/DevTools.Startup/DevTools.Startup.wapproj` as startup project.
+* Now you should be able to build and run DevToys on your machine. If it fails, try close the solution and reopen it again.
+
+**If x64 doesn't work, use the architecture of your system*
+
+# Coding
+
+## Versioning
+
+The application version use the following pattern :
+
+```
+year.month.day.buildCountInTheDay
+```
+
+Each time that the solution is built in `Release` mode, version number are updated.
+
+## Main architecture
+
+DevToys is using [MEF](https://docs.microsoft.com/en-us/dotnet/framework/mef/) as dependency injection framework.
+Every tools available (i.e Base64 Encoder/Decoder, JSON Formatter, Settings...) are dynamically discovered and instanciated through MEF. A tool is divided in 3 components:
+1. `IToolProvider` and its metadata, which represents the tool as displayed in the main menu in the app. `IToolProvider` should be MEF exported.
+2. `IToolViewModel`, which is a ViewModel as described by MVVM pattern in UWP. It doesn't have to be MEF exported but may be required depending on what the tool needs to work.
+3. A `Page` that represents the view of the tool.
+
+## Code Style
+
+1. DO use `PascalCase`:
+- class names
+- method names
+- const names
+
+2. DO use `camelCase`:
+- method arguments
+- local variables
+- private fields
+
+4. DO NOT use Hungarian notation.
+
+5. DO NOT use underscores, hyphens, or any other nonalphanumeric characters.
+
+6. DO NOT use Caps for any names.
+
+7. DO use predefined type names like `int`, `string` etc. instead of `Int32`, `String`.
+
+8. DO use `_` prefix for private field names.
+
+9. DO use `I` prefix for Interface names.
+
+10. DO vertically align curly brackets.
+
+11. DO NOT use `Enum` or `Flag(s)` suffix for Enum names.
+
+12. DO use prefix `Is`, `Has`, `Have`, `Any`, `Can` or similar keywords for Boolean names.
+
+13. DO use curly brackets for single line `if`, `for` and `foreach` statements.
diff --git a/README.md b/README.md
index 0ca446aab..333bc4506 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,47 @@
-# Introduction
-TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
-
-# Getting Started
-TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
-1. Installation process
-2. Software dependencies
-3. Latest releases
-4. API references
-
-# Build and Test
-TODO: Describe and show how to build your code and run the tests.
-
-# Contribute
-TODO: Explain how other users and developers can contribute to make your code better.
-
-If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
-- [ASP.NET Core](https://github.com/aspnet/Home)
-- [Visual Studio Code](https://github.com/Microsoft/vscode)
-- [Chakra Core](https://github.com/Microsoft/ChakraCore)
\ No newline at end of file
+<p align="center">
+ <img width="128" align="center" src="src/dev/startup/DevTools.Startup/Assets/Logo/Square150x150Logo.scale-200.png">
+</p>
+<h1 align="center">
+ DevToys
+</h1>
+<p align="center">
+ A Swiss-knife for developers.
+</p>
+<p align="center">
+ <a style="text-decoration:none" href="//TODO">
+ <img src="https://img.shields.io/badge/Microsoft%20Store-DevToys-green" alt="Store link" />
+ </a>
+</p>
+
+## Introduction
+
+![DevToys](//TODO-Screenshot.png)
+
+## How to install (as an end-user)
+
+### Prerequisite
+- You need Windows 10 build 1903+ or later.
+
+### Microsoft Store
+- Search for DevToys in the Microsoft Store App or click [here](//TODO)
+
+### Manual
+
+- Download and extract the latest [release](//TODO).
+- Double click the *.msixbundle file.
+
+## Please, avoid selling this app as yours
+
+I don't care if you copy the source code to use in your project, but please avoid simply changing the name and selling as your work.
+That's not why I'm sharing the source code, at all.
+
+## Contribute
+See [CONTRIBUTING](CONTRIBUTING.md)
+
+## Third-Party Softwares
+
+See [ThirdPartyNotices](//TODO)
+
+## License
+
+See [LICENSE](//TODO)
\ No newline at end of file
diff --git a/src/DevTools.sln b/src/DevTools.sln
index 12c1e1c89..e005beb5c 100644
--- a/src/DevTools.sln
+++ b/src/DevTools.sln
@@ -15,6 +15,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DevTools", "dev\startup\Dev
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{B4C026E3-9BBF-434B-A14D-712C6A3731E4}"
ProjectSection(SolutionItems) = preProject
+ ..\.vsconfig = ..\.vsconfig
+ ..\CONTRIBUTING.md = ..\CONTRIBUTING.md
Directory.Build.props = Directory.Build.props
Directory.Build.targets = Directory.Build.targets
..\README.md = ..\README.md
diff --git a/src/dev/impl/DevTools.Common/Strings/en/MainPage.resw b/src/dev/impl/DevTools.Common/Strings/en/MainPage.resw
index a634808f9..8446d3edb 100644
--- a/src/dev/impl/DevTools.Common/Strings/en/MainPage.resw
+++ b/src/dev/impl/DevTools.Common/Strings/en/MainPage.resw
@@ -130,9 +130,9 @@
<value>Type to search for tools...</value>
</data>
<data name="WindowTitle" xml:space="preserve">
- <value>DevTools</value>
+ <value>DevToys</value>
</data>
<data name="WindowTitleWithToolName" xml:space="preserve">
- <value>DevTools - {0}</value>
+ <value>DevToys - {0}</value>
</data>
</root>
\ No newline at end of file
diff --git a/src/dev/impl/DevTools.Common/Strings/en/Settings.resw b/src/dev/impl/DevTools.Common/Strings/en/Settings.resw
index 3d444aef9..454fd2a05 100644
--- a/src/dev/impl/DevTools.Common/Strings/en/Settings.resw
+++ b/src/dev/impl/DevTools.Common/Strings/en/Settings.resw
@@ -127,7 +127,7 @@
<value>Select which app theme to display</value>
</data>
<data name="AppTitle" xml:space="preserve">
- <value>DevTools</value>
+ <value>DevToys</value>
</data>
<data name="Behaviors" xml:space="preserve">
<value>Behaviors</value>
diff --git a/src/dev/impl/DevTools.Common/Strings/fr/MainPage.resw b/src/dev/impl/DevTools.Common/Strings/fr/MainPage.resw
index 2b5ec4763..4667fcb80 100644
--- a/src/dev/impl/DevTools.Common/Strings/fr/MainPage.resw
+++ b/src/dev/impl/DevTools.Common/Strings/fr/MainPage.resw
@@ -130,9 +130,9 @@
<value>Taper pour recherche un outil...</value>
</data>
<data name="WindowTitle" xml:space="preserve">
- <value>DevTools</value>
+ <value>DevToys</value>
</data>
<data name="WindowTitleWithToolName" xml:space="preserve">
- <value>DevTools - {0}</value>
+ <value>DevToys - {0}</value>
</data>
</root>
\ No newline at end of file
diff --git a/src/dev/shared/SharedAssemblyInfo.cs b/src/dev/shared/SharedAssemblyInfo.cs
index 5b23aa6e8..0c180e36b 100644
--- a/src/dev/shared/SharedAssemblyInfo.cs
+++ b/src/dev/shared/SharedAssemblyInfo.cs
@@ -16,7 +16,7 @@ using System.Reflection;
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Etienne BAUDOUX")]
-[assembly: AssemblyProduct("DevTools")]
+[assembly: AssemblyProduct("DevToys")]
[assembly: AssemblyCopyright("© Etienne BAUDOUX. All rights reserved.")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]
diff --git a/src/dev/startup/DevTools.Startup/Package.appxmanifest b/src/dev/startup/DevTools.Startup/Package.appxmanifest
index 340f50450..8c0943687 100644
--- a/src/dev/startup/DevTools.Startup/Package.appxmanifest
+++ b/src/dev/startup/DevTools.Startup/Package.appxmanifest
@@ -16,7 +16,7 @@
<mp:PhoneIdentity PhoneProductId="c12088ee-f979-4809-8039-7851a3aa2b7a" PhonePublisherId="00000000-0000-0000-0000-000000000000"/>
<Properties>
- <DisplayName>DevTools</DisplayName>
+ <DisplayName>DevToys</DisplayName>
<PublisherDisplayName>ebaud</PublisherDisplayName>
<Logo>Assets\Logo\StoreLogo.png</Logo>
</Properties>
@@ -36,8 +36,8 @@
EntryPoint="$targetentrypoint$"
desktop4:SupportsMultipleInstances="true">
<uap:VisualElements
- DisplayName="DevTools"
- Description="DevTools"
+ DisplayName="DevToys"
+ Description="DevToys"
BackgroundColor="transparent"
Square150x150Logo="Assets\Logo\Square150x150Logo.png"
Square44x44Logo="Assets\Logo\Square44x44Logo.png">
@@ -52,8 +52,8 @@
</uap:VisualElements>
<Extensions>
<uap:Extension Category="windows.protocol">
- <uap:Protocol ReturnResults="none" Name="devtools">
- <uap:DisplayName>DevTools URI Scheme</uap:DisplayName>
+ <uap:Protocol ReturnResults="none" Name="devtoys">
+ <uap:DisplayName>DevToys URI Scheme</uap:DisplayName>
<uap:Logo>Assets\Logo\Square512.png</uap:Logo>
</uap:Protocol>
</uap:Extension>
diff --git a/src/dev/startup/DevTools/Package.appxmanifest b/src/dev/startup/DevTools/Package.appxmanifest
index ce723922a..e9ff9d2dd 100644
--- a/src/dev/startup/DevTools/Package.appxmanifest
+++ b/src/dev/startup/DevTools/Package.appxmanifest
@@ -14,7 +14,7 @@
<mp:PhoneIdentity PhoneProductId="c12088ee-f979-4809-8039-7851a3aa2b7a" PhonePublisherId="00000000-0000-0000-0000-000000000000"/>
<Properties>
- <DisplayName>DevTools</DisplayName>
+ <DisplayName>DevToys</DisplayName>
<PublisherDisplayName>ebaud</PublisherDisplayName>
<Logo>Assets\Logo\StoreLogo.png</Logo>
</Properties>
@@ -32,10 +32,10 @@
Executable="$targetnametoken$.exe"
EntryPoint="DevTools.App">
<uap:VisualElements
- DisplayName="DevTools"
+ DisplayName="DevToys"
Square150x150Logo="Assets\Logo\Square150x150Logo.png"
Square44x44Logo="Assets\Logo\Square44x44Logo.png"
- Description="DevTools"
+ Description="DevToys"
BackgroundColor="transparent">
<uap:DefaultTile Wide310x150Logo="Assets\Logo\Wide310x150Logo.png"/>
<uap:SplashScreen Image="Assets\Logo\SplashScreen.png" />
diff --git a/src/dev/startup/DevTools/Properties/AssemblyInfo.cs b/src/dev/startup/DevTools/Properties/AssemblyInfo.cs
index 4032f0b22..e8fbcc839 100644
--- a/src/dev/startup/DevTools/Properties/AssemblyInfo.cs
+++ b/src/dev/startup/DevTools/Properties/AssemblyInfo.cs
@@ -1,3 +1,3 @@
using System.Reflection;
-[assembly: AssemblyTitle("DevTools")]
\ No newline at end of file
+[assembly: AssemblyTitle("DevToys")]
\ No newline at end of file