From d3456d4b28f24e10b05ef2b4915e5998a5cdab90 Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Mon, 11 Sep 2017 08:26:37 +0100 Subject: [PATCH] Created Developing Smeagol (markdown) --- Developing-Smeagol.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 Developing-Smeagol.md diff --git a/Developing-Smeagol.md b/Developing-Smeagol.md new file mode 100644 index 0000000..682fcd0 --- /dev/null +++ b/Developing-Smeagol.md @@ -0,0 +1,24 @@ +## Prerequisites + +You will need [Leiningen](https://github.com/technomancy/leiningen) 2.0 or above installed. + +You will need [node](https://nodejs.org/en/) and [bower](https://bower.io/) installed. + +## Running in development +To start a web server for the application during development, run: + + lein bower install + lein ring server + +This should start a development server, and open a new window or tab in your default browser with the default page of the wiki loaded into it. + +## Editing +I generally use [LightTable](http://lighttable.com/) as my `Clojure` editor, but it doesn't really matter what you use; if you run Smeagol as described above, then all changes you make in the code (and save) will instantly be applied to the running system. This makes for a productive development environment. + +## Documentation +It is my intention that the code should be sufficiently well documented to be easy to understand. Documentation may be generated from the code by running + + lein codox + +## Contributing +If you make changes to Smeagol which you think are useful, please contribute them in the form of a [pull request on github](https://help.github.com/articles/creating-a-pull-request/).