CrystalSplitter/ghcitui
1
1
Fork 0
mirror of https://github.com/CrystalSplitter/ghcitui.git synced 2024-11-26 09:42:38 +03:00
Code Issues Packages Projects Releases Wiki Activity

Mention git lfs in the install

Browse Source
This commit is contained in:
CrystalSplitter 2024-01-16 23:31:35 -08:00 committed by Jordan R AW
parent f9c4af6c68
commit f8d92f8134
1 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
INSTALL.rst
View File

@ -4,6 +4,9 @@ BUILD AND INSTALLATION
This document describes how to build, install, and test the GHCiTUI program. 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 GHCiTUI is configured, built, and installed through `Cabal`_. Cabal can be
installed through the ``ghcup`` command line tool. Familiarity with Cabal installed through the ``ghcup`` command line tool. Familiarity with Cabal
is not necessary to build GHCiTUI. is not necessary to build GHCiTUI.
@ -12,8 +15,15 @@ is not necessary to build GHCiTUI.
Getting the source Getting the source
------------------ ------------------
Currently the source code is hosted on https://github.com. You can check out Currently the source code is hosted at
the source code using ``git`` with SSH: 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 .. code-block:: shell
@ -48,3 +58,4 @@ Contributors may find it useful to make their own
.. _Cabal: https://www.haskell.org/cabal/ .. _Cabal: https://www.haskell.org/cabal/
.. _cabal.project: ./cabal.project .. _cabal.project: ./cabal.project
.. _install git-lf separately: https://git-lfs.com/