/
installation.html
60 lines (51 loc) · 4.98 KB
/
installation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<html>
<head>
<link rel="stylesheet" href="../../PRODUCT_PLUGIN/book.css" type="text/css">
<script type="text/javascript" src="PLUGINS_ROOT/org.eclipse.help/livehelp.js">
</script>
</head>
<body>
<h1>Installation steps</h1>
<p>If you see this, you have successfully installed the eclipseFP plugins.
However there may still be some configuration steps to be done before you can use the plugins fully.</p>
<h3>GHC configuration</h3>
<p>
EclipseFP requires GHC to compile Haskell source files.
We recommend installing the <a href="http://hackage.haskell.org/platform/">Haskell Platform</a> that comes with all required libraries bundled in a installer for your platform.
You can configure GHC by opening the Eclipse Preferences and going to <a href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=net.sf.eclipsefp.haskell.ui.internal.preferences.hsimpls.InstalledImplementationsPP)")'>Haskell > Haskell implementations</a>. If a GHC is in your PATH you should see it in the list. Otherwise you can manually add a GHC installation.
</p>
<h3>Cabal configuration</h3>
<p>
EclipseFP also requires a working Cabal. <a href="http://www.haskell.org/haskellwiki/Cabal">Cabal</a> is a build management tool for Haskell. Similarly, the Haskell Platform contains a version of Cabal compatible with the GHC it ships with.
You can configure Cabal in the Eclipse Preferences under <a href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=net.sf.eclipsefp.haskell.ui.internal.preferences.scion.ScionPP)")'>Haskell > Helper executables</a>. By default EclipseFP will have looked in your PATH and use any Cabal installation it can find there.
</p>
<h3>BuildWrapper and Browser configuration</h3>
<p>
BuildWrapper is a Haskell program that uses GHC and Cabal to give a consistent API to manage and build Haskell projects. EclipseFP uses BuildWrapper for a lot of operations.
Scion-Browser is another small component that serves information about the installed packages in your system.
Both should be installed from Hackage before working with Haskell projects in EclipseFP. You can use the <a href='javascript:executeCommand("org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=net.sf.eclipsefp.haskell.ui.views.CabalPackagesView)")'>Cabal Packages</a> view to install them easily.
The Eclipse Preferences page under <a href='javascript:executeCommand("org.eclipse.ui.window.preferences(preferencePageId=net.sf.eclipsefp.haskell.ui.internal.preferences.scion.ScionPP)")'>Haskell > Helper executables</a> allows you to change settings if required.
</p>
<h4>Problems building BuildWrapper and Browser</h4>
<p>
It may happen that BuildWrapper or Browser do not build successfully when you install them either through the <code>cabal install</code> command line tool or through the <a href='javascript:executeCommand("org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=net.sf.eclipsefp.haskell.ui.views.CabalPackagesView)")'>Cabal Packages</a> view.
The install process when launched from inside EclipseFP dumps its outputs and errors into a Console in the Console View of Eclipse. Please check this file for errors.
Often, the build fails due to some libraries conflict. Please run <code>cabal update</code> (use for example the <b>Update package list</b> button the in the <a href='javascript:executeCommand("org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=net.sf.eclipsefp.haskell.ui.views.CabalPackagesView)")'>Cabal Packages</a> view) before relaunching the installation.
This will ensure your Cabal knows about the latest versions of libraries available on Hackage.
</p>
<h3>Extra programs</h3>
<p>
You will get extra functionality if you install several Haskell programs. To be more concrete:
<ul>
<li>If you install <a href="http://www.haskell.org/hoogle/">Hoogle</a>, you will be able to search functions or types in your installed packages. To get it, run <code>cabal install hoogle</code>
in a console. The next time EclipseFP starts, it will detect and configure it for use.</li>
<li>If you install <a href="http://community.haskell.org/~ndm/hlint/">HLint</a>, suggestions for improving your code will appear in the Haskell editor. Install it running
<code>cabal install hlint</code>.</li>
<li>EclipseFP can run unit tests created with <a href="http://batterseapower.github.com/test-framework/">Test-framework</a>. You can install it running
<code>cabal install test-framework test-framework-quickcheck2 test-framework-hunit</code> (to be able to use QuickCheck and HUnit tests).</li>
<li>You can produce information about your modules using <a href="http://hackage.haskell.org/package/SourceGraph">SourceGraph</a>. Get it executing <code>cabal install SourceGraph</code>.</li>
</ul>
<i>Note: You can of course install these programs from inside EclipseFP through the <a href='javascript:executeCommand("org.eclipse.ui.views.showView(org.eclipse.ui.views.showView.viewId=net.sf.eclipsefp.haskell.ui.views.CabalPackagesView)")'>Cabal Packages</a> view.</i>
</p>
</body>
</html>