Update README.md

README.md

@@ -1 +1,23 @@
-# VSCode2Msi
+# VSCode2Msi
+### What?
+VSCode2Msi is a tool for creating a Windows Installer (MSI) package from official microsoft releases.
+### Why?
+Microsoft doesn't publish MSIs for VSCode but some people prefer or require MSI installers (eg. GPO deployment).
+### How?
+VSCode2Msi repackages a zip release of VSCode using WiX.
+
+## Usage
+### Requirements
+- A recent WiX version, both 4 and 5 should work
+- WixToolset.UI extension
+- A recent Windows version with dotnet framework 4.7.2 (mono on linux _could_ work, but it's untested and not recommended)
+### Installation
+- Install the WiX command line: https://wixtoolset.org/docs/intro/
+- Install the WixToolset.UI extension: `wix extension add -g WixToolset.UI.wixext`
+- Download VSCode2Msi from the releases page or build it from source
+### Building the MSI
+Just run `VSCode2Msi.exe`, this should download VSCode build the msi in the current directory, for advanced options run `VSCode2Msi.exe --help`
+
+### Limitations
+- Arm64 is currently untested and the current configuration is propably incompatible, though it could work with slight modifications. (eg. change platform attribute and use different zip file)
+- Automatic updates don't work, you can however create a MSI from a newer VSCode release and it will update your existing installation.