aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2020-11-13 12:15:04 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2020-11-13 13:18:09 +0300
commit9438554ec20d189a45eff6a3c51be8dc5a1a901b (patch)
treebabb44e2fb58084210723efad28186a00ce7595d /README.md
parentinitial commit (diff)
downloadvs-shell-9438554ec20d189a45eff6a3c51be8dc5a1a901b.tar.gz
vs-shell-9438554ec20d189a45eff6a3c51be8dc5a1a901b.zip
add README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee3daae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+Set up Visual Studio shell
+==========================
+
+This is a GitHub action that sets up a Visual Studio shell in your workflow
+run.
+This is similar to running one of the vcvars*.bat scripts or launching one of
+the "Command Tools for VS" Start Menu shortcuts, but it's also shell-agnostic.
+Use it in your workflow like this:
+
+ - name: Set up Visual Studio shell
+ uses: egor-tensin/vs-shell@v1
+ with:
+ arch: x64
+
+`x64` is the default value for the `arch` parameter and can be omitted.
+Use `x86` if you want to build 32-bit binaries.
+
+License
+-------
+
+Distributed under the MIT License.
+See [LICENSE.txt] for details.
+
+[LICENSE.txt]: LICENSE.txt