.. _software-prereq:

Software prerequisites
&&&&&&&&&&&&&&&&&&&&&&

Let's install the software prerequisites, including Fossil itself!
Feel free to bookmark this guide as a reference for setting up Fossil
on your other computers.

The supported operating systems are:

- :ref:`Microsoft Windows <software-prereq-windows>` (I personally
  tested on Windows 10)
- :ref:`Mac OS X <software-prereq-osx>` (user tested, on High Sierra,
  I think)
- :ref:`Debian/Ubuntu Linux <software-prereq-gnu-plus-linux>`
  (I personally tested on Debian Stretch and Buster)

.. _software-prereq-windows:

Windows
#######

Step-by-step version
====================

Cygwin
------

The default Windows shell (aka "command prompt") is awful. We'll
instead set up Cygwin and ZSH.

Installing Cygwin
^^^^^^^^^^^^^^^^^

Download the Cygwin installer HERE_, then run it, and follow the
instructions below.

.. _HERE: https://www.cygwin.com/setup-x86_64.exe

.. image:: /_static/cygwin-1.png
.. image:: /_static/cygwin-2.svg
.. image:: /_static/cygwin-3.svg

Pick the following packages in the list (use the search box):

#. wget
#. ca-certificates

.. image:: /_static/cygwin-4.svg
.. image:: /_static/cygwin-5.svg

Setup script
^^^^^^^^^^^^

I wrote a script that does the remainder of the setup
automagically. What you need to do is the following:

#. Right-click on the newly created "Cygwin Terminal" shortcut on your
   Desktop, and select "Run as Administrator".
#. Copy the following line of code in its entirety, then paste into
   the terminal window (note: ``<ctrl>-v`` won't work, so either use
   ``<shift>+<insert>`` or right-click and select "paste")::

      wget https://static.ecd.space/x/vc-workshop-201805/scripts/setup.sh -O setup.sh && bash setup.sh SETUP_CYGWIN_INSTALL=y SETUP_FOSSIL_SETTINGS=y

   .. image:: /_static/paste.png

#. Press ``<enter>`` to run the command.

Other software
--------------

These are software packages you just need to download, then mindlessly
click-through to install.

.. _software-prereq-windows-activetcl:

Tcl/Tk
^^^^^^

ActiveTcl_ is needed to enable the built-in graphical diff feature in
Fossil.

.. _ActiveTcl: https://downloads.activestate.com/ActiveTcl/releases/8.6.9.0/ActiveTcl-8.6.9.8609.2-MSWin32-x64.exe

.. image:: /_static/tcl-1.svg
.. image:: /_static/tcl-2.svg

Meld
^^^^

Meld_ is an excellent graphical diff program. Given two versions of a
text file, it allows you to quickly see what changed between them.

.. _Meld: https://meldmerge.org/

VS Code
^^^^^^^

`VS Code`_ is a great text editor (and more).

.. _`VS Code`: https://code.visualstudio.com/

.. _software-prereq-osx:

Mac OS X
########

In a terminal, copy-paste and run the following command in its entirety::

  curl -fsSL -o setup.sh https://static.ecd.space/x/vc-workshop-201805/scripts/setup.sh && bash setup.sh SETUP_BREW_INSTALL=y SETUP_CHSH=y SETUP_FOSSIL_SETTINGS=y

You're done!

.. include:: setup_warnings.txt

.. _software-prereq-gnu-plus-linux:

Debian GNU/Linux
################

(This might also work on Ubuntu, I haven't checked.)

In a terminal, copy-paste and run the following command in its entirety::

  curl -fsSL -o setup.sh https://static.ecd.space/x/vc-workshop-201805/scripts/setup.sh && bash setup.sh SETUP_CHSH=y SETUP_APT_MISC=y SETUP_APT_FOSSIL_BUILDDEP=y SETUP_BUILD_FOSSIL=y SETUP_FOSSIL_SETTINGS=y

You're done!

.. include:: setup_warnings.txt