From 6e907cc85d93b81b8393278bf003085790aa336a Mon Sep 17 00:00:00 2001 From: Simon Brooke Date: Thu, 23 Jan 2020 08:43:49 +0000 Subject: [PATCH] Upversioned to '1.0.3-SNAPSHOT'; amended README. --- README.md | 63 ++++++++++++++++++++++++++++++++--------------------- project.clj | 2 +- 2 files changed, 39 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 6cc0691..84b1577 100644 --- a/README.md +++ b/README.md @@ -110,38 +110,29 @@ Parameters semantics: Security warning: At the moment there is no check against directory traversal attack. So include feature may expose files outside of your wiki content-dir. -## Advertisement -If you like what you see here, I am available for work on open source Clojure projects. - -### Phoning home -Smeagol currently requests the WEFT logo in the page footer from my home site. This is mainly so I can get a feel for how many people are using the product. If you object to this, edit the file - - resources/templates/base.html - -and replace the line - - The Web Engineering Factory & Toolworks Developed by WEFT - -with the line - - The Web Engineering Factory & Toolworks Developed by WEFT - -## License -Copyright © 2014-2015 Simon Brooke. Licensed under the GNU General Public License, -version 2.0 or (at your option) any later version. If you wish to incorporate -parts of Smeagol into another open source project which uses a less restrictive -license, please contact me; I'm open to dual licensing it. - ## 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 -To start a web server for the application, run: +## Development +To start a development web server for the application, run: lein bower install - lein ring server + lein repl + +And then, when the repl starts up, + + (start-server) + +## Running + +To build a standalone Smeagol jar file, run: + + lein bower install + lein ring uberjar + +**HOWEVER**, this will not run without [configuration](https://github.com/journeyman-cc/smeagol/blob/develop/resources/public/content/Environment%20Variables.md). Alternatively, if you want to deploy to a servlet container (which I would strongly recommend), the simplest thing is to run: @@ -172,3 +163,25 @@ To build your own Docker image, run: lein docker build This will build a new Docker image locally; you can, obviously, push it to your own Docker repository if you wish. + +## Advertisement +If you like what you see here, I am available for work on open source Clojure projects. + +### Phoning home +Smeagol currently requests the WEFT logo in the page footer from my home site. This is mainly so I can get a feel for how many people are using the product. If you object to this, edit the file + + resources/templates/base.html + +and replace the line + + The Web Engineering Factory & Toolworks Developed by WEFT + +with the line + + The Web Engineering Factory & Toolworks Developed by WEFT + +## License +Copyright © 2014-2020 Simon Brooke. Licensed under the GNU General Public License, +version 2.0 or (at your option) any later version. If you wish to incorporate +parts of Smeagol into another open source project which uses a less restrictive +license, please contact me; I'm open to dual licensing it. diff --git a/project.clj b/project.clj index 877f474..4af209d 100644 --- a/project.clj +++ b/project.clj @@ -1,4 +1,4 @@ -(defproject smeagol "1.0.2" +(defproject smeagol "1.0.3-SNAPSHOT" :description "A simple Git-backed Wiki inspired by Gollum" :url "https://github.com/simon-brooke/smeagol" :license {:name "GNU General Public License,version 2.0 or (at your option) any later version"