aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorEgor Tensin <Egor.Tensin@gmail.com>2021-04-18 11:28:34 +0300
committerEgor Tensin <Egor.Tensin@gmail.com>2021-05-15 14:58:03 +0300
commit0bbffd30dc6a6d3b4a819d3eb8ecdc9c7bdf4480 (patch)
tree00d25fa5692f018b54bb43d180599cff3057b547 /README.md
parentREADME: update (diff)
downloadvs-shell-0bbffd30dc6a6d3b4a819d3eb8ecdc9c7bdf4480.tar.gz
vs-shell-0bbffd30dc6a6d3b4a819d3eb8ecdc9c7bdf4480.zip
README: update
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index 8476d07..5e67892 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,11 @@ Visual Studio shell
[![Test](https://github.com/egor-tensin/vs-shell/actions/workflows/test.yml/badge.svg)](https://github.com/egor-tensin/vs-shell/actions/workflows/test.yml)
-This is a GitHub action that sets up a Visual Studio shell in your workflow
-run.
+This GitHub action 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
@@ -14,7 +15,7 @@ Use it in your workflow like this:
with:
arch: x64
-`x64` is the default value for the `arch` parameter and can be omitted.
+* `x64` is the default value for the `arch` parameter and can be omitted.
Use `x86` if you want to build 32-bit binaries.
API