Commit 4f858f58 authored by Ian D. Bollinger's avatar Ian D. Bollinger
Browse files

README: fix local links

* Attempt to fix local links.
* Experiment with syntax highlighting.
* Add title to HACKING.
* Reword an awkward sentence and a few wordy headings.
* Change "Unix" to "Unix-like".
parent fd7692a4
The Cabal library package
=========================
The [Cabal web site].
See the [Cabal web site] for more information.
If you also want the `cabal` command-line program, you need the
[cabal-install] package in addition to this library.
[cabal-install]: ../cabal-install/README.md
Installation instructions for the Cabal library
===============================================
Installing the Cabal library
============================
If you have the `cabal` program already
---------------------------------------
......@@ -92,22 +92,24 @@ harder but still possible.
Unpack Cabal and `filepath` into separate directories. For example:
tar -xzf filepath-1.1.0.0.tar.gz
tar -xzf Cabal-1.6.0.0.tar.gz
``````````````````````````````````````````````````````shell
tar -xzf filepath-1.1.0.0.tar.gz
tar -xzf Cabal-1.6.0.0.tar.gz
# rename to make the following instructions simpler:
mv filepath-1.1.0.0/ filepath/
mv Cabal-1.6.0.0/ Cabal/
# rename to make the following instructions simpler:
mv filepath-1.1.0.0/ filepath/
mv Cabal-1.6.0.0/ Cabal/
cd Cabal
ghc -i../filepath -cpp --make Setup.hs -o ../filepath/setup
cd ../filepath/
./setup configure --user
./setup build
./setup install
cd Cabal
ghc -i../filepath -cpp --make Setup.hs -o ../filepath/setup
cd ../filepath/
./setup configure --user
./setup build
./setup install
```````````````````````````````````````````````````````````
This installs `filepath` so you are then in a position to install Cabal
by the normal method.
This installs `filepath` so that you can install Cabal with the normal
method.
More information
......
Contributing to Cabal
=====================
If you want to hack on Cabal, don't be intimidated!
Read the guide to the source code at:
......
......@@ -4,9 +4,9 @@
This Cabal Git repository contains the following packages:
* (Cabal)[Cabal/README.md]: the Cabal library package
* (cabal-install)[cabal-install/README.md]: the package containing the `cabal` tool
* (Cabal)[./Cabal/README.md]: the Cabal library package
* (cabal-install)[./cabal-install/README.md]: the package containing the `cabal` tool
See [HACKING.md] for information about contributing.
See [./HACKING.md] for information about contributing.
The canonical upstream repository is located at https://github.com/haskell/cabal
......@@ -10,8 +10,8 @@ can build and install both local and remote packages, including
dependencies.
Installation instructions for the `cabal` command line tool
===========================================================
Installing the `cabal` command-line tool
========================================
The `cabal-install` package requires a number of other packages, most of
which come with a standard GHC installation. It requires the [network]
......@@ -40,11 +40,12 @@ partially automated. It is described below.
[.cabal]: cabal-install.cabal
[network]: http://hackage.haskell.org/package/network
Quick start on Unix systems
---------------------------
Quick start on Unix-like systems
--------------------------------
As a convenience for users on Unix systems, there is a [bootstrap.sh]
script that will download and install each of the dependencies in turn.
As a convenience for users on Unix-like systems, there is a
[./bootstrap.sh] script that will download and install each of the
dependencies in turn.
$ ./bootstrap.sh
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment