bat file docs
@echo off
-
@REM Copyright (C) 2020 PyMedPhys Contributors
@REM Licensed under the Apache License, Version 2.0 (the "License");
@REM limitations under the License.
+@REM ==========================================================================
+@REM Documentation
+@REM ==========================================================================
+
+@REM This bat file exposes the PyMedPhys CLI. To see what this CLI can do have
+@REM a read through of the documentation:
+
+@REM https://docs.pymedphys.com/ref/cli/index.html
+
+@REM ---------------------------------------------
+@REM How to use this batfile anywhere on your PC
+@REM ---------------------------------------------
+
+@REM If you would like to access this CLI tool accross your system you need to
+@REM add the directory that contains this `.bat` file into your user path.
+@REM To do this, open the start menu and type:
+
+@REM "Edit environment variables for your account"
+
+@REM From there, find the variable called "PATH". Append to the end of that
+@REM variable the directory containing this `.bat` file. Make sure that each
+@REM directory within the "PATH" is separated by a semicolon (;).
+
+@REM For example, if your "PATH" originally looked like:
+
+@REM C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;
+
+@REM And this `.bat` file is located at `C:\Users\sbiggs\bin\pymedphys.bat`,
+@REM then you would change it to look like:
+
+@REM C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Users\sbiggs\bin;
+
+@REM -----------------------------------
+@REM A note about shortcuts and moving
+@REM -----------------------------------
+
+@REM This batfile will only work if it is in the same location as the
+@REM extracted `python-embed` directory. Also, shortcuts to this bat file will
+@REM not work as one might expect. If you would like to use this bat file
+@REM outside of its original directory please follow the instructions detailed
+@REM above.
+
+@REM ==========================================================================
+
"%~dp0\python-embed\python" -m pymedphys %*
