claferwiki 0.3.5 → 0.3.5.1
raw patch · 4 files changed
+30/−33 lines, 4 filesdep ~clafer
Dependency ranges changed: clafer
Files
- Makefile +6/−8
- README.md +18/−19
- claferwiki.cabal +5/−5
- claferwiki.sh +1/−1
Makefile view
@@ -1,26 +1,24 @@-dependencies: - cabal install -fhighlighting pandoc - cabal install gitit +all: + cabal install install: + @if test ! -d ".git"; then \ + cp -f -r .git $(to); \ + fi mkdir -p $(to) cp -f gitit.cnf $(to) cp -f claferwiki.sh $(to) chmod +x $(to)/claferwiki.sh cp -f README.md $(to) - cp -f -r .git $(to) mkdir -p $(to)/static/img cp -f static/img/logo.png $(to)/static/img mkdir -p $(to)/static/css cp -f static/css/custom.css $(to)/static/css/custom.css cp -f static/css/clafer.css $(to)/static/css/clafer.css - mkdir -p $(to)/plugins - cabal install update: cp -f claferwiki.sh $(to) cp -f README.md $(to) cp -f static/img/logo.png $(to)/static/img cp -f static/css/custom.css $(to)/static/css/custom.css - cp -f static/css/clafer.css $(to)/static/css/clafer.css - cabal install+ cp -f static/css/clafer.css $(to)/static/css/clafer.css
README.md view
@@ -1,7 +1,7 @@ Clafer Wiki =========== -v0.3.5.20-01-2014 +v0.3.5.1.1 **ClaferWiki** is a wiki system integrated with [Clafer compiler](https://github.com/gsdlab/clafer). [Clafer](http://clafer.org) is a lightweight yet powerful structural modeling language. ClaferWiki allows for embedding Clafer model fragments in wiki pages and provides model authoring support including code highlighting, parse and semantic error reporting, hyperlinking from identifier use to its definition, and graphical view rendering. @@ -19,21 +19,19 @@ ------------ * Chris Walker, co-op student May-Aug, 2012. Developer of Clafer Wiki, HTML and GraphViz generators. -* [Michał Antkiewicz](http://gsd.uwaterloo.ca/mantkiew), Research Engineer. Requirements, development, architecture, testing, technology transfer. -* [Jimmy Liang](http://gsd.uwaterloo.ca/jliang), MSc. Candidate. Clafer compiler support, including multi-fragment compilation, source/AST/IR traceability, parsing and compilation error reporting. - -Getting Clafer Tools --------------------- +* [Michał Antkiewicz](http://gsd.uwaterloo.ca/mantkiew), Requirements, development, architecture, testing, technology transfer. +* [Jimmy Liang](http://gsd.uwaterloo.ca/jliang), Clafer compiler support, including multi-fragment compilation, source/AST/IR traceability, parsing and compilation error reporting. -Binary distributions of the release 0.3.5 of Clafer Tools for Windows, Mac, and Linux, -can be downloaded from [Clafer Tools - Binary Distributions](http://http://gsd.uwaterloo.ca/clafer-tools-binary-distributions). -Clafer Wiki requires Haskell Platform and MinGW to run on Windows. +Getting the Clafer Wiki +----------------------- -In case these binaries do not work on your particular machine configuration, the tools can be built from source code, as described below. +Clafer can be installed either from Hackage or from the source code. ### Dependencies for running -* [Clafer compiler](https://github.com/gsdlab/clafer/) v0.3.5. +Regardless of the installation method, the following are required: + +* [Clafer compiler](https://github.com/gsdlab/clafer/) v0.3.5.1. * [The Haskell Platform](http://hackage.haskell.org/platform) v2013.2.0.0. * alternatively, GHC v7.6.3. * [Git](http://git-scm.com) @@ -43,16 +41,17 @@ 1. `cabal update` 2. `cabal install claferwiki` +3. `cd <cabal's lib or share folder>/claferwiki-0.3.5.1` (`lib` on Windows or `share` on Linux and Mac) + * execute `make install to=<target directory>` + * this will copy the wiki files and `cabal install` the package `claferwiki` ### Installation from source code -1. install the Haskell Platform -2. install Git -3. install Clafer compiler from source code in some `<source directory>` where you want to have the wiki source code, -4. execute `git clone git://github.com/gsdlab/claferwiki.git` -5. execute `make dependencies` to install `pandoc` with code highlighting support and `gitit` -6. execute `make install to=<target directory>` - * this will copy the wiki files and `cabal install` the package `claferwiki` +1. In some `<source directory>` where you want to have the wiki source code + * execute `git clone git://github.com/gsdlab/claferwiki.git` +2. execute `cabal install` +3. execute `make install to=<target directory>` + * this will copy the wiki files ### Important: Branches must correspond @@ -137,6 +136,6 @@ * Try a live instance of [ClaferIDE](http://t3-necsis.cs.uwaterloo.ca:8094) * Try a live instance of [ClaferConfigurator](http://t3-necsis.cs.uwaterloo.ca:8093) * Try a live instance of [ClaferMooVisualizer](http://t3-necsis.cs.uwaterloo.ca:8092) -* Take a look at (incomplete) [Clafer wiki](https://github.com/gsdlab/clafer/wiki) +* Take a look at (incomplete) [Clafer by examples wiki](https://github.com/gsdlab/clafer/wiki) * Browse example models in the [test suite](https://github.com/gsdlab/clafer/tree/master/test/positive) and [MOO examples](https://github.com/gsdlab/clafer/tree/master/spl_configurator/dataset) * Post questions, report bugs, suggest improvements [GSD Lab Bug Tracker](http://gsd.uwaterloo.ca:8888/questions/). Tag your entries with `claferwiki` (so that we know what they are related to) and with `michal` (so that Michał gets a notification).
claferwiki.cabal view
@@ -1,15 +1,15 @@ Name: claferwiki -version: 0.3.5 +version: 0.3.5.1 stability: experimental -author: Michal Antkiewicz, Chris Walker, Luke Michael Brown -maintainer: mantkiew@gsd.uwaterloo.ca +author: Michał Antkiewicz, Chris Walker, Luke Michael Brown +maintainer: Michał Antkiewicz <mantkiew@gsd.uwaterloo.ca> synopsis: A wiki-based IDE for literate modeling with Clafer description: A wiki-based IDE for literate modeling with Clafer. A Plugin for the Gitit wiki which collects code blocks written in Clafer (.clafer), compiles them, renders into HTML and Dot, and replaces the code blocks with the results. homepage: http://github.com/gsdlab/claferwiki category: Wiki cabal-version: >= 1.16 build-type: Simple -copyright: Michal Antkiewicz, Chris Walker, Luke Michael Brown +copyright: Michał Antkiewicz, Chris Walker, Luke Michael Brown license: MIT license-file: LICENSE tested-with: GHC == 7.6.3 @@ -45,7 +45,7 @@ pandoc-types == 1.10.*, gitit >= 0.10.3.1, - clafer == 0.3.5 + clafer == 0.3.5.1 hs-source-dirs: src ghc-options: -Wall -fno-warn-unused-do-bind -fno-warn-orphans exposed-modules:
claferwiki.sh view
@@ -1,5 +1,5 @@ echo "-----------------------------------------" -echo "| ClaferWiki v0.3.5.20-01-2014 |" +echo "| ClaferWiki v0.3.5.1 |" echo "| https://github.com/gsdlab/claferwiki/ |" echo "| By Michal Antkiewicz, Chris Walker |" echo "| Generative Software Development Lab |"