summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/qsharp/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/qsharp/README.md')
-rw-r--r--macros/latex/contrib/qsharp/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/macros/latex/contrib/qsharp/README.md b/macros/latex/contrib/qsharp/README.md
new file mode 100644
index 0000000000..0c2fca8ced
--- /dev/null
+++ b/macros/latex/contrib/qsharp/README.md
@@ -0,0 +1,17 @@
+# qsharp.sty #
+
+This package provides LaTeX syntax highlighting for Q#.
+
+## Installing ##
+
+### Install With PowerShell ###
+
+In an attempt to cut down on the pain of LaTeX package installation, ``{qsharp}`` uses [PoShTeX](https://github.com/cgranade/posh-tex/) to automate installation.
+If you're running PowerShell already, just run ``Install.ps1``:
+
+```powershell
+PS> Unblock-File Install.ps1 # Mark the installer as safe to run.
+PS> ./Install.ps1
+```
+
+PowerShell itself is easy to install on many macOS and Linux systems using the [provided packages](https://github.com/PowerShell/PowerShell#get-powershell).