Browse files

Update docs

--HG--
rename : INSTALL.txt => INSTALL.md
rename : PROBLEMS.txt => PROBLEMS.md
rename : README.txt => README.md
  • Loading branch information...
1 parent 1634b83 commit a5176f87931dfbcb3355f62e67ed4a25e345db2e @bos committed May 19, 2011
Showing with 104 additions and 103 deletions.
  1. +7 −0 .hgignore
  2. +49 −0 INSTALL.md
  3. +0 −58 INSTALL.txt
  4. +5 −0 Makefile
  5. +20 −0 PROBLEMS.md
  6. +0 −20 PROBLEMS.txt
  7. +10 −16 README.txt → README.md
  8. +13 −9 llvm.cabal
View
7 .hgignore
@@ -0,0 +1,7 @@
+^(?:INSTALL.html|PROBLEMS.html|README.html|autom4te.cache|dist|llvm.buildinfo)$
+^config\.(?:status)$
+^tests/(?:\.hpc|ps)$
+\.(?:aux|eventlog|h[ip]|log|[oa]|orig|prof|ps|rej|swp)$
+~$
+syntax: glob
+.\#*
View
49 INSTALL.md
@@ -0,0 +1,49 @@
+Build and installation instructions
+-----------------------------------
+
+Please don't think of these as canonical build instructions yet, as
+this work is rather early along. Let me tell you what's working for
+*me*, and hopefully this information will be enough to get you going.
+
+
+Prerequisites
+-------------
+
+Firstly, you'll need to have LLVM. I recommend installing LLVM
+version 2.8 or later (from [llvm.org](http://llvm.org/releases/)), which is what
+this package has been tested with.
+
+It's easy to install LLVM itself from source:
+
+ cd llvm
+ ./configure --prefix=$SOMEWHERE
+ make
+ make install
+
+It's a good idea to have `$SOMEWHERE/bin` in your path.
+
+Installing from source on Windows requires MinGW.
+
+
+Building
+--------
+
+This is a normal Haskell package, but needs a `configure` script to
+configure some system-specific details of LLVM.
+
+ cabal install --configure-option --with-llvm-prefix=$SOMEWHERE
+
+If you have LLVM installed in a fairly normal location (`/usr` or
+`/usr/local`), you don't need the `--configure-option` bits.
+
+
+Building examples
+-----------------
+
+In the examples directory are a few example programs. There's a GNU
+Makefile in there, so running `make` in that directory will build the
+examples, as will `make examples` in the top-level directory. Doing
+`make run` will build and run the examples.
+
+Note: On older versions of MacOS X you may see a lot of "atom sorting
+error" warnings. They seem to be harmless.
View
58 INSTALL.txt
@@ -1,58 +0,0 @@
-Build and installation instructions
------------------------------------
-
-Please don't think of these as canonical build instructions yet, as
-this work is rather early along. Let me tell you what's working for
-*me*, and hopefully this information will be enough to get you going.
-
-
-Prerequisites
--------------
-
-Firstly, you'll need to have LLVM. I recommend installing LLVM
-version 2.6 (from llvm.org) which is what it's been tested with.
-
-Install from source.:
-Build this and install it somewhere. Follow the LLVM instructions,
-or use this:
-
- cd llvm
- ./configure --prefix=$SOMEWHERE
- make
- make install
-
-It's a good idea to have $SOMEWHERE/bin is in your path.
-
-Installing from source on Windows requires MinGW.
-
-
-Building
---------
-It's normal cabal package, but using a configure script as well to
-configure LLVM. Do A or B.
-
-A) If you have cabal-install just do
- cabal install --configure-option --with-llvm-prefix=$SOMEWHERE
-
-B) If you don't have cabal-install:
-
-Configure the package.
- runhaskell Setup configure --configure-option --with-llvm-prefix=$SOMEWHERE
-
-Build.
- runhaskell Setup build
-
-Install.
- runhaskell Setup install
-
-
-Building examples
------------------
-
-In the examples directory are a few example programs. There's a GNU
-Make Makefile in there, so running "make" in that directory will build
-the examples, as will "make examples" in the top-level directory.
-Doing "make run" will build and run the examples.
-
-Note: On MacOS X you get a lot of "atom sorting error" warnings. They
-seem to be harmless.
View
5 Makefile
@@ -34,6 +34,11 @@ examples:
tests:
$(MAKE) -C tests
+html: INSTALL.html PROBLEMS.html README.html
+
+%.html: %.md
+ pandoc -s -o $@ $<
+
doc haddock: dist/setup-config
./setup haddock
View
20 PROBLEMS.md
@@ -0,0 +1,20 @@
+Known problems
+--------------
+
+If you have solutions to any of the problems listed below, please let
+me know, or better yet, send a patch. Thanks!
+
+
+Can't use LLVM bindings from ghci
+---------------------------------
+
+When I try to use the LLVM bindings in `ghci`, on Linux, loading the
+bindings succeeds, but trying to do anything fails:
+
+ $ ghci
+ Prelude> :m +LLVM.Core
+ Prelude LLVM.Core> m <- createModule "foo"
+ can't load .so/.DLL for: stdc++ (libstdc++.so: cannot open shared
+ object file: No such file or directory)
+
+I don't know why this happens, but it looks like a `ghci` bug.
View
20 PROBLEMS.txt
@@ -1,20 +0,0 @@
-Known problems
---------------
-
-If you have solutions to any of the problems listed below, please let
-me know, or better yet, send a patch. Thanks!
-
-
-Can't use LLVM bindings from ghci
----------------------------------
-
-When I try to use the LLVM bindings in ghci, on Linux, loading the
-bindings succeeds, but trying to do anything fails:
-
- $ ghci
- Prelude> :m +LLVM.Core
- Prelude LLVM.Core> m <- createModule "foo"
- can't load .so/.DLL for: stdc++ (libstdc++.so: cannot open shared
- object file: No such file or directory)
-
-I don't know why this happens, but it looks like a ghci bug.
View
26 README.txt → README.md
@@ -1,27 +1,20 @@
Haskell LLVM bindings
---------------------
-This package provides Haskell bindings for the popular LLVM compiler
-infrastructure project. If you don't know what LLVM is, the main LLVM
-home page is here:
-
- http://llvm.org/
+This package provides Haskell bindings for the popular
+[LLVM](http://llvm.org/) compiler infrastructure project.
Configuration
-------------
-By default, when you run "cabal install" or "runghc Setup configure",
-the Haskell bindings will be configured to install to /usr/local. The
-configure script will look for your LLVM installation in that same
-directory.
-
-If you have LLVM installed in a different location, e.g. /usr, you can
-tell the configure script where to find it as follows:
+By default, when you run `cabal install`, the Haskell bindings will be
+configured to look for LLVM in `/usr/local`.
- cabal install --configure-option=--with-llvm-prefix=/usr
+If you have LLVM installed in a different location, e.g. `/usr`, you
+can tell the `configure` script where to find it as follows:
- runghc Setup configure --configure-option=--with-llvm-prefix=/usr
+ cabal install --configure-option=--with-llvm-prefix=/usr
Package status - what to expect
@@ -43,8 +36,9 @@ Jump in and help!
We welcome your comments and contributions. You can send email to us
at <bos@serpentine.com> or <lennart@augustsson.net>. If you want to
-send patches, please get a copy of the darcs repository:
+send patches, please clone a copy of the
+[git repository](https://github.com/bos/llvm):
- darcs get http://code.haskell.org/llvm/
+ git clone git://github.com/bos/llvm
Thanks!
View
22 llvm.cabal
@@ -1,5 +1,5 @@
name: llvm
-version: 0.9.1.1
+version: 0.9.1.2
license: BSD3
license-file: LICENSE
synopsis: Bindings to the LLVM compiler toolkit.
@@ -25,19 +25,19 @@ description:
* New in 0.7.0.0: Adapted to LLVM 2.6;
author: Bryan O'Sullivan, Lennart Augustsson
maintainer: Bryan O'Sullivan <bos@serpentine.com>, Lennart Augustsson <lennart@augustsson.net>
-bug-reports: Lennart Augustsson <lennart@augustsson.net>
-homepage: http://code.haskell.org/llvm/
+homepage: https://github.com/bos/llvm
+bug-reports: https://github.com/bos/llvm/issues
stability: experimental
category: Compilers/Interpreters, Code Generation
-tested-with: GHC == 6.10.4, GHC == 6.12.3
+tested-with: GHC == 6.10.4, GHC == 6.12.3, GHC == 7.0.3
cabal-version: >= 1.10
build-type: Custom
extra-source-files:
- INSTALL.txt
+ INSTALL.md
Makefile
- PROBLEMS.txt
- README.txt
+ PROBLEMS.md
+ README.md
configure
configure.ac
examples/Align.hs
@@ -137,5 +137,9 @@ library
cbits/free.c
source-repository head
- type: darcs
- location: http://code.haskell.org/llvm/
+ type: git
+ location: https://github.com/bos/llvm/
+
+source-repository head
+ type: mercurial
+ location: https://github.com/bos/llvm/

0 comments on commit a5176f8

Please sign in to comment.