mirror of
https://github.com/CrystalSplitter/ghcitui.git
synced 2024-09-11 10:55:29 +03:00
Mention git lfs in the install
This commit is contained in:
parent
f9c4af6c68
commit
f8d92f8134
15
INSTALL.rst
15
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/
|
||||
|
Loading…
Reference in New Issue
Block a user