Commit 3a1a1c19 authored by Ian D. Bollinger's avatar Ian D. Bollinger
Browse files

README: rename tests/README and update .cabal files.

* Ensure README.md is in .cabal files.
* Remove some verbiage.
* Remove broken link to old wiki in HACKING.
parent e22be924
......@@ -24,7 +24,7 @@ build-type: Custom
-- that we build Setup.lhs using our own local Cabal source code.
extra-source-files:
README tests/README changelog
README.md tests/README.md changelog
-- Generated with 'misc/gen-extra-source-files.sh' & 'M-x sort-lines':
tests/PackageTests/BenchmarkExeV10/Foo.hs
......
......@@ -14,7 +14,7 @@ Installing the Cabal library
If you already have the `cabal` program
---------------------------------------
In this case it is simple, just run
In this case run:
$ cabal install
......@@ -60,8 +60,8 @@ install into `$ProgramFiles/Haskell`. If you want to install elsewhere,
use the `--prefix=` flag at the configure step.
Working with older versions of GHC and Cabal
============================================
Using older versions of GHC and Cabal
======================================
It is recommended that you leave any pre-existing version of Cabal
installed. In particular, it is *essential* you keep the version that
......@@ -77,14 +77,12 @@ installed, you should probably remove it by running:
or, if you had Cabal installed only for your user account, run:
````````````````````````````shell
$ ghc-pkg unregister Cabal --user
`````````````````````````````````
$ ghc-pkg unregister Cabal --user
The `filepath` dependency
=========================
Cabal uses the `filepath` package, so it must be installed first.
Cabal uses the `[filepath]` package, so it must be installed first.
GHC version 6.6.1 and later come with `filepath`, however, earlier
versions do not by default. If you do not already have `filepath`,
you need to install it. You can use any existing version of Cabal to do
......@@ -93,25 +91,24 @@ harder but still possible.
Unpack Cabal and `filepath` into separate directories. For example:
``````````````````````````````````````````````````````shell
tar -xzf filepath-1.1.0.0.tar.gz
tar -xzf Cabal-1.6.0.0.tar.gz
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 that you can install Cabal with the normal
method.
[filepath]: http://hackage.haskell.org/package/filepath
More information
================
......
......@@ -3,17 +3,16 @@ Contributing to Cabal
If you want to hack on Cabal, don't be intimidated!
Read the [guide to the source
code](https://github.com/haskell/cabal/wiki/Source-Guide).
* Read the [guide to the source
code](https://github.com/haskell/cabal/wiki/Source-Guide).
Subscribe to the [mailing
list](http://www.haskell.org/mailman/listinfo/cabal-devel).
* Subscribe to the [mailing
list](http://www.haskell.org/mailman/listinfo/cabal-devel).
Browse the [list of open issues](https://github.com/haskell/cabal/issues).
* Browse the [list of open issues](https://github.com/haskell/cabal/issues).
There are other resources listed on the [development
wiki](https://github.com/haskell/cabal/wiki) and [old
wiki](http://hackage.haskell.org/trac/hackage/).
* There are other resources listed on the [development
wiki](https://github.com/haskell/cabal/wiki).
Of particular value are the open issues list and the cabal-devel mailing
list, which is a good place to ask questions.
......
......@@ -5,9 +5,9 @@ See the [Cabal web site](http://www.haskell.org/cabal/) for more
information.
The `cabal-install` package provides a command line tool named `cabal`.
It uses the `Cabal` library and provides a convenient user interface to
the Cabal/[Hackage] build automation and package management system. It
can build and install both local and remote packages, including
It uses the `Cabal` library and provides a user interface to the
Cabal/[Hackage] build automation and package management system. It can
build and install both local and remote packages, including
dependencies.
......@@ -22,7 +22,7 @@ for example, on Debian or Ubuntu, it is located in the
`cabal` requires a few other Haskell packages that are not always
installed. The exact list is specified in the [.cabal] file or in the
[boostrap.sh] file. All these packages are available from [Hackage].
[bootsrap.sh] file. All these packages are available from [Hackage].
Note that on some Unix systems you may need to install an additional
zlib development package using your system package manager; for example,
......@@ -39,7 +39,7 @@ be built in the standard way; to facilitate this, the process is
partially automated. It is described below.
[.cabal]: cabal-install.cabal
[boostrap.sh]: boostrap.sh
[bootstrap.sh]: bootstrap.sh
[network]: http://hackage.haskell.org/package/network
Quick start on Unix-like systems
......
......@@ -22,7 +22,7 @@ Copyright: 2005 Lemmih <lemmih@gmail.com>
2007-2012 Duncan Coutts <duncan@community.haskell.org>
Category: Distribution
Build-type: Simple
Extra-Source-Files: README bash-completion/cabal bootstrap.sh
Extra-Source-Files: README.md bash-completion/cabal bootstrap.sh
Cabal-Version: >= 1.8
source-repository head
......
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