Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 92 lines (58 sloc) 2.09 kb
daad9b2f »
2008-11-12 Start a README.
1
2 Introduction
3 ============
4
5 [Scion][home] is a Haskell library that aims to provide Haskell source
6 code inspection and transformation functionality as well as various
7 other features that may be useful for an IDE.
8
9 Most of Scion's functionality is based on the GHC API. Scion tries to
10 be front-end agnostic; it provides both a Haskell API and servers for
11 non-Haskell clients such as Emacs or Vim.
12
13 [home]: http://code.google.com/p/scion-lib/
14
15
16 Installation
17 ============
18
19 Scion requires [GHC 6.10.1][ghc] or later. All other dependencies
20 should be on [Hackage] and can be installed using
21 [cabal-install]:
22
23 $ cd dir/to/scion
24 $ cabal install
25
26 Scion supports various configuration flags which are useful when
27 working on Scion itself.
28
29 [ghc]: http://haskell.org/ghc/download.html
30 [Hackage]: http://hackage.haskell.org/packages/hackage.html
31 [cabal-install]: http://hackage.haskell.org/trac/hackage/wiki/CabalInstall
32
33 Usage
34 =====
35
36 TODO
37
38 Emacs
39 -----
40
41 TODO
42
43 $ cd <scion>
44 $ cabal install -femacs
45 $ ./.cabal/bin/emacs_server
46
47 Emacs:
48
49 (add-to-list 'load-path "<scion>/emacs")
50 (require 'scion)
51
52 (add-hook 'haskell-mode-hook 'my-scion-hook)
53 (defun my-scion-hook ()
54 (scion-mode 1))
55
56 M-x scion-connect
57 M-x scion-load-cabal-project
58 M-x scion-load-library
59
60 C-c i l -- insert language pragma
61 C-c i p -- insert pragma
62 C-c i m -- insert (external) module name
63
64
65 Bug Reports
66 ===========
67
68 Please send bug reports or feature requests to the [Issue tracker][issues].
69
70 [issues]: http://code.google.com/p/scion-lib/issues/list
71
50099dba »
2008-11-14 Add link to mailing list to README.
72 Discussion
73 ==========
74
96ce6f22 »
2008-11-14 Github's markdown implementation is buggy... grrr..
75 For discussions about Scion use the [scion-lib-devel][ml] mailing list.
50099dba »
2008-11-14 Add link to mailing list to README.
76
96ce6f22 »
2008-11-14 Github's markdown implementation is buggy... grrr..
77 [ml]: http://groups.google.com/group/scion-lib-devel
50099dba »
2008-11-14 Add link to mailing list to README.
78
daad9b2f »
2008-11-12 Start a README.
79
80 Hacking
81 =======
82
83 The main repository for Scion is hosted on [Github]. Get it via
84
85 $ git clone git://github.com/nominolo/scion
86
87 Send patches or pull requests to nominolo (email address at googlemail
88 dot com). Note that, if you fork the project on Github your fork
89 won't take up additional space on your account.
90
91 [Github]: http://github.com
Something went wrong with that request. Please try again.