diff --git a/docs/introduction/install.rst b/docs/introduction/install.rst index 3a5e6073a..935feccd3 100644 --- a/docs/introduction/install.rst +++ b/docs/introduction/install.rst @@ -1,17 +1,18 @@ +=============== Install Auspice =============== Prerequisites -------------- +============= Auspice is a JavaScript program, and requires `Node.js `__ to be installed on your system. Refer to ``engines.node`` in `package.json `__ for currently supported versions. -We highly recommend using `Conda `__ to manage environments, i.e. use Conda to create an environment with Node.js installed where you can use Auspice. It’s possible to use other methods, but this documentation presupposes that you have Conda installed. +We highly recommend using `Conda `__ to manage environments, i.e. use Conda to create an environment with Node.js installed where you can use Auspice. It's possible to use other methods, but this documentation presupposes that you have Conda installed. -To run package scripts, the ```bash`` shell `__ and the ```env`` `__ command need to be in your ``PATH``. You should already have them on Unix-like systems including Linux and macOS. If you are working from Windows, you can run the installation under Git Bash, MSYS2, or Cygwin. You can also use the Windows Subsystem Linux for a fuller Linux environment. +To run package scripts, the `bash shell `__ and the `env `__ command need to be in your ``PATH``. You should already have them on Unix-like systems including Linux and macOS. If you are working from Windows, you can run the installation under Git Bash, MSYS2, or Cygwin. You can also use the Windows Subsystem Linux for a fuller Linux environment. Create a Conda Environment --------------------------- +========================== .. code:: bash @@ -20,16 +21,16 @@ Create a Conda Environment .. - This parallels `the Nextstrain installation docs `__. You’re welcome to use those instead! + This parallels `the Nextstrain installation docs `__. You're welcome to use those instead! Install Auspice from npm ------------------------- +======================== .. code:: bash npm install --global auspice -Auspice should now be available as a command-line program – check by running ``auspice --help``. +Auspice should now be available as a command-line program - check by running ``auspice --help``. If you look at the `release notes `__ you can see the changes that have been made to Auspice (see your version of Auspice via ``auspice --version``). To upgrade, you can run @@ -38,9 +39,9 @@ If you look at the `release notes