Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 6fb08fd

Browse files
committedFeb 17, 2013
Added install guide.
Ignored idea projects. Ignored dist directory. Added documentation headers.
1 parent 22df79b commit 6fb08fd

File tree

4 files changed

+82
-0
lines changed

4 files changed

+82
-0
lines changed
 

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.idea
2+
dist/
3+

‎INSTALL.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
Installation Instructions
2+
=========================
3+
This program is written in Haskell and built using cabal.
4+
To build, you will need:
5+
* haskell-platform
6+
7+
#### Building
8+
9+
For best results:
10+
1. Run "cabal clean".
11+
2. Run "cabal configure".
12+
3. Run "cabal build" to compile the sources to dist/.
13+
14+
#### Installation
15+
16+
Optionally:
17+
* Run "cabal install --prefix=/usr/local/" to install the program.
18+
19+
#### Testing
20+
21+
1. Run "cabal clean".
22+
2. Run "cabal configure".
23+
3. Run "cabal build" to compile the sources to dist/.
24+
4. Run "cabal test" to run the tests.
25+
26+
#### Running
27+
28+
* Run "./diffr" to run the program from within the build directory, or if installed, just run "diffr".
29+
* Run "./patchr" to run the program from within the build directory, or if installed, just run "patchr".
30+
31+
#### Documentation
32+
33+
* Run "cabal configure".
34+
* Run "cabal haddock --executables" to generate documentation.
35+

‎diff/Main.hs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
{- |
2+
Module : Diffr.Main
3+
Description : Main entry point for diffr.
4+
Since : 0.0
5+
Authors : William Martin
6+
License : This file is part of diffr-h.
7+
8+
diffr-h is free software: you can redistribute it and/or modify
9+
it under the terms of the GNU General Public License as published by
10+
the Free Software Foundation, either version 3 of the License, or
11+
(at your option) any later version.
12+
13+
diffr-h is distributed in the hope that it will be useful,
14+
but WITHOUT ANY WARRANTY; without even the implied warranty of
15+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16+
GNU General Public License for more details.
17+
You should have received a copy of the GNU General Public License
18+
along with diffr-h. If not, see <http://www.gnu.org/licenses/>.
19+
-}
20+
21+
module Diffr.Main where
22+
123
import System.Environment
224

325
-- | 'main' runs the main program

‎patch/Main.hs

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
1+
{- |
2+
Module : Patchr.Main
3+
Description : Main entry point for patchr.
4+
Since : 0.0
5+
Authors : William Martin
6+
License : This file is part of diffr-h.
7+
8+
diffr-h is free software: you can redistribute it and/or modify
9+
it under the terms of the GNU General Public License as published by
10+
the Free Software Foundation, either version 3 of the License, or
11+
(at your option) any later version.
12+
13+
diffr-h is distributed in the hope that it will be useful,
14+
but WITHOUT ANY WARRANTY; without even the implied warranty of
15+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16+
GNU General Public License for more details.
17+
You should have received a copy of the GNU General Public License
18+
along with diffr-h. If not, see <http://www.gnu.org/licenses/>.
19+
-}
20+
21+
module Patchr.Main where
22+
123
import System.Environment
224

325
-- | 'main' runs the main program

0 commit comments

Comments
 (0)
Please sign in to comment.