diff --git a/INSTALL.rst b/INSTALL.rst index 7f3c08c..5e9a732 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -4,6 +4,9 @@ BUILD AND INSTALLATION This document describes how to build, install, and test the GHCiTUI program. +At present, installation has only been tested on Linux systems. While +installation may work on other operating systems, you may encounter issues. + GHCiTUI is configured, built, and installed through `Cabal`_. Cabal can be installed through the ``ghcup`` command line tool. Familiarity with Cabal is not necessary to build GHCiTUI. @@ -12,8 +15,15 @@ is not necessary to build GHCiTUI. Getting the source ------------------ -Currently the source code is hosted on https://github.com. You can check out -the source code using ``git`` with SSH: +Currently the source code is hosted at +https://github.com/CrystalSplitter/ghcitui. You can check out the source code +using ``git``. + +Note however that the repository is configured with ``git lfs`` +to store documentation images, so if you want images in your checkout, you +must `install git-lfs separately`_. + +Checking out with SSH: .. code-block:: shell @@ -48,3 +58,4 @@ Contributors may find it useful to make their own .. _Cabal: https://www.haskell.org/cabal/ .. _cabal.project: ./cabal.project +.. _install git-lf separately: https://git-lfs.com/