Added information about test-suite to README.md
Signed-off-by: Collin J. Doering <collin.doering@rekahsoft.ca>
This commit is contained in:
parent
fa36bb8062
commit
283e4ce8e5
58
README.md
58
README.md
|
@ -1,27 +1,35 @@
|
||||||
# Source Code for **[#! λ Slang](http://blog.rekahsoft.ca)**
|
# Source Code for **[#! λ Slang](http://blog.rekahsoft.ca)**
|
||||||
|
|
||||||
|
* [Features](#features)
|
||||||
|
* [Tools](#tools)
|
||||||
|
* [License](#license)
|
||||||
|
* [Building](#building)
|
||||||
|
* [Running Tests](#running-tests)
|
||||||
|
* [Issues](#issues)
|
||||||
|
|
||||||
[#! λ Slang](http://blog.rekahsoft.ca) is the personal technical blog of *Collin Doering*,
|
[#! λ Slang](http://blog.rekahsoft.ca) is the personal technical blog of *Collin Doering*,
|
||||||
built using software that [respects our freedoms](https://www.gnu.org/philosophy/free-sw.html).
|
built using software that [respects our freedoms](https://www.gnu.org/philosophy/free-sw.html).
|
||||||
|
|
||||||
## Features
|
## Features <a name="features"></a>
|
||||||
|
|
||||||
* [Single Page Application (SPA)](http://en.wikipedia.org/wiki/Single-page_application)
|
* [Single Page Application (SPA)](http://en.wikipedia.org/wiki/Single-page_application)
|
||||||
* Utilizes CSS 3
|
* Utilizes CSS 3
|
||||||
* Uses HTML5 Application Cache for offline viewing of website
|
* Uses HTML5 Application Cache for offline viewing of website
|
||||||
|
|
||||||
## Tools
|
## Tools <a name="tools"></a>
|
||||||
|
|
||||||
The creation of this website was made possible by the following open source tools and libraries:
|
The creation of this website was made possible by the following open source tools and libraries:
|
||||||
|
|
||||||
* [Hakyll][] used to generate site from static files
|
* [Hakyll][] is used to generate site from static files
|
||||||
* [Clay][] used for CSS pre-processing
|
* [Clay][] is used for CSS pre-processing
|
||||||
* [Skeleton][] used for CSS boilerplate
|
* [Skeleton][] is used for CSS boilerplate
|
||||||
* [MathJax][] used for rendering mathematics
|
* [MathJax][] is used for rendering mathematics
|
||||||
* [Inkscape][] and the [Gimp][] were used to create various images/artwork
|
* [Inkscape][] and the [Gimp][] were used to create various images/artwork
|
||||||
|
* [Selenium][] is used for automated testing using real browsers
|
||||||
* [Gnu Free Fonts][], specifically *FreeMono* is used as main font
|
* [Gnu Free Fonts][], specifically *FreeMono* is used as main font
|
||||||
* [Gnu Emacs][], because there is no place like home; and no greater editor!
|
* [Gnu Emacs][], because there is no place like home; and no greater editor!
|
||||||
|
|
||||||
## License
|
## License <a name="license"></a>
|
||||||
|
|
||||||
Simply put, you're welcome to use the code used to generate this site though there are a few restrictions:
|
Simply put, you're welcome to use the code used to generate this site though there are a few restrictions:
|
||||||
|
|
||||||
|
@ -33,7 +41,7 @@ Various licenses ([GPLv3][], [Creative Commons BY-NC-SA License][], and
|
||||||
[Creative Commons BY-NC-ND License][]) are deployed dependent on which part of the site is in
|
[Creative Commons BY-NC-ND License][]) are deployed dependent on which part of the site is in
|
||||||
question. Please see the LICENSE file for full details.
|
question. Please see the LICENSE file for full details.
|
||||||
|
|
||||||
## Building
|
## Building <a name="building"></a>
|
||||||
|
|
||||||
All that is needed to build this site is cabal and a way to fetch required packages (whether
|
All that is needed to build this site is cabal and a way to fetch required packages (whether
|
||||||
directly via the internet or by using the ```fetch``` argument to cabal).
|
directly via the internet or by using the ```fetch``` argument to cabal).
|
||||||
|
@ -45,12 +53,46 @@ directly via the internet or by using the ```fetch``` argument to cabal).
|
||||||
$ ./site build # build site
|
$ ./site build # build site
|
||||||
$ ./site server # view site at http://localhost:3000
|
$ ./site server # view site at http://localhost:3000
|
||||||
|
|
||||||
|
## Running Tests <a name="running-tests"></a>
|
||||||
|
|
||||||
|
To the run the tests that accompany this site, one must have [Selenium][] installed and an
|
||||||
|
instances running on port 4444. Then one must run the following:`
|
||||||
|
|
||||||
|
$ cabal configure --enable-tests
|
||||||
|
$ cabal install --only-dependencies
|
||||||
|
$ cabal test
|
||||||
|
|
||||||
|
## Issues <a name="issues"></a>
|
||||||
|
|
||||||
|
Unfortunately, when trying to install the test-suite dependencies, `webdriver 0.6.1` fails to
|
||||||
|
install when using GHC 7.10 (*Jun 24, 2015*). This is due to a missing language pragma
|
||||||
|
`FlexibleContexts` in `src/Test/WebDriver/Commands.hs` (see
|
||||||
|
[bug ticket](https://github.com/kallisti-dev/hs-webdriver/issues/71). To get around this
|
||||||
|
problem you can download `webdriver` from hackage using `cabal get webdriver` and then fix the
|
||||||
|
problem yourself by adding the language pragma to the file `src/Test/WebDriver/Commands.hs`.
|
||||||
|
This issue has also been fixed upstream so you can use git to get the latest sources. Once the
|
||||||
|
working sources for `webdriver-0.6.1` are in place, run the following:
|
||||||
|
|
||||||
|
$ cd webdriver-0.6.1
|
||||||
|
$ cabal sandbox init
|
||||||
|
$ cabal configure
|
||||||
|
$ cabal install --only-dependencies
|
||||||
|
$ cabal build
|
||||||
|
$ cabal install
|
||||||
|
$ cd ..
|
||||||
|
$ cabal sandbox init --sandbox webdriver-0.6.1/.cabal-sandbox
|
||||||
|
|
||||||
|
This will share the cabal sandbox which we used to build and install our fixed version of
|
||||||
|
webdriver, with this project. Now the test-suite can be run once its dependencies are installed
|
||||||
|
(see [Running Tests](#running-tests)).
|
||||||
|
|
||||||
[Hakyll]: http://jaspervdj.be/hakyll/
|
[Hakyll]: http://jaspervdj.be/hakyll/
|
||||||
[Clay]: http://fvisser.nl/clay/
|
[Clay]: http://fvisser.nl/clay/
|
||||||
[Skeleton]: http://www.getskeleton.com/
|
[Skeleton]: http://www.getskeleton.com/
|
||||||
[JQuery]: http://jquery.com
|
[JQuery]: http://jquery.com
|
||||||
[JQuery-address]: https://github.com/asual/jquery-address
|
[JQuery-address]: https://github.com/asual/jquery-address
|
||||||
[MathJax]: http://www.mathjax.org/
|
[MathJax]: http://www.mathjax.org/
|
||||||
|
[Selenium]: http://docs.seleniumhq.org/
|
||||||
[Inkscape]: http://inkscape.org/
|
[Inkscape]: http://inkscape.org/
|
||||||
[Gimp]: http://www.gimp.org/
|
[Gimp]: http://www.gimp.org/
|
||||||
[Gnu Emacs]: http://www.gnu.org/software/emacs/
|
[Gnu Emacs]: http://www.gnu.org/software/emacs/
|
||||||
|
|
Loading…
Reference in New Issue