Skip to content

Commit

Permalink
Updated docs to show that macOS is supported
Browse files Browse the repository at this point in the history
  • Loading branch information
ianmkenney committed Oct 19, 2023
1 parent 8600240 commit 426fa5d
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ mdahole2 is bound by a [Code of Conduct](https://github.com/MDAnalysis/hole2-mda

### Installation

To build mdahole2 from source,
To build `mdahole2` from source,
we highly recommend using virtual environments.
If possible, we strongly recommend that you use
[Anaconda](https://docs.conda.io/en/latest/) as your package manager.
Below we provide instructions both for `conda` and
for `pip`.

Note that `mdahole2` is only supported on Linux and macOS.

#### With conda

Ensure that you have [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.
Expand Down
9 changes: 5 additions & 4 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Getting Started
===============

This page details how to get started with `mdahole2`.
This page details how to get started with ``mdahole2``.
Note that ``mdahole2`` is only supported on Linux or macOS.

Documentation
~~~~~~~~~~~~~
Expand All @@ -13,7 +14,7 @@ Documentation is hosted on `GitHub Pages`_.
Download source code
~~~~~~~~~~~~~~~~~~~~

The `mdahole2` source code is hosted on GitHub_ and can be downloaded with
The ``mdahole2`` source code is hosted on GitHub_ and can be downloaded with

.. code:: bash
Expand All @@ -30,8 +31,8 @@ with an SSH key, or with
Build and installation
~~~~~~~~~~~~~~~~~~~~~~

`mdahole2` is currently only installable from source (although hosting on conda-forge is planned).
As such `conda-build` is required. To download this utility, invoke:
``mdahole2`` is currently only installable from source (although hosting on conda-forge is planned).
As such ``conda-build`` is required. To download this utility, invoke:

.. code:: bash
Expand Down

0 comments on commit 426fa5d

Please sign in to comment.