Permalink
Browse files

Added license information

  • Loading branch information...
1 parent 10a86a6 commit b4b1ac9b27d826e51e32017a3271b2b7f2845560 @matthewroach committed Nov 27, 2012
Showing with 33 additions and 12 deletions.
  1. +16 −0 license.txt
  2. +17 −12 readme.md
View
@@ -0,0 +1,16 @@
+Almanac - An OpenBD (ColdFusion) blog powered by static JSON / markdown files.
+
+Copyright (C) 2012 - Matthew Roach
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see <http://www.gnu.org/licenses/>.
View
@@ -8,7 +8,7 @@ This is a simple solution I made to power my own blog, to use two items I love,
## Getting Started
-Take a copy of the this repository, either dowload the zip or fork it.
+Take a copy of the this repository, either dowload the zip or fork it.
This repository contains everything OpenBD related to get you started, but you will need some software or a server to get up and running to try it out. If you are familiar with running up ColdFusion sites or in particular OpenBD you'll know what your doing. If not depending on where you wish to have this running will depending on what you require
@@ -26,8 +26,8 @@ To run this locally on your computer you need to ensure you have Java installed
#### Windows
1. Download the Jetty Desktop Launcher ( [Download](http://www.aw20.co.uk/codegarden/jettylauncher/) - Instructions on site )
-2. Open Jetty Desktop Launcher
- 1. Enter Name
+2. Open Jetty Desktop Launcher
+ 1. Enter Name
2. Choose the folder where you have downloaded Almanac
3. Enter port number
4. Save, then Start, within a few seconds you will see a Goto Web App button, click this and it will open your default web browser showing you Almanac
@@ -36,19 +36,19 @@ To run this locally on your computer you need to ensure you have Java installed
The following instructions can be used for linux based computers or on a linux server. Obviously if you are going to deploy to the internet you need to lock down your server on top of these instructions.
-1. Download the OpenBD Read2Run Nightly Build ( [Download](http://openbd.org/download/nightly/jetty-openbd.zip)
+1. Download the OpenBD Read2Run Nightly Build ( [Download](http://openbd.org/download/nightly/jetty-openbd.zip) )
2. Extract the zip to a folder named jetty-openbd
3. Make an almanac folder inside of the jetty-openbd/webapps folder
4. Copy the contents of Almanac you downloaded at the start into the newly create almanac folder
-5. Open the file openbd.xml location in the jetty-openbd/contexts folder and change the line 22 to the following :
+5. Open the file openbd.xml location in the jetty-openbd/contexts folder and change the line 22 to the following :
`<Set name="war"><SystemProperty name="jetty.home" default="."/>/webapps/almanac</Set>`
-6. By default Jetty will run on Port 8080, but if you wish to change this open the file jetty.xml in jetty-openbd/etc/ and change the port number on line 40, it looks like :
+6. By default Jetty will run on Port 8080, but if you wish to change this open the file jetty.xml in jetty-openbd/etc/ and change the port number on line 40, it looks like :
`<Set name="port"><Property name="jetty.port" default="8080"/></Set>`
-7. In terminal navigate yourself to the jetty-openbd folder and use the following command:
+7. In terminal navigate yourself to the jetty-openbd folder and use the following command:
`java -jar start.jar`
@@ -72,9 +72,9 @@ The settings file is located in the root, and called settings.json and the defau
"url" : "blog",
"homeCount" : 3,
"pageFolder" : "pages",
-
+
"dateFormat" : "EEEE, d MMMM yyyy",
-
+
"templates" : {
"home" : "/a/templates/index.inc",
"header" : "/a/templates/global/header.inc",
@@ -85,7 +85,7 @@ The settings file is located in the root, and called settings.json and the defau
}
-**Title**
+**Title**
This is what appears in the title bar on everypage, on article view pages it appears after the article title
@@ -113,7 +113,7 @@ The templates object is a list of templates and their location from the root fol
### Page Format
-We use a mixture of JSON and Markdown for a page format files, the pages are located in the folder specified in the "pageFolder" setting from your settings.json file.
+We use a mixture of JSON and Markdown for our page format files, the pages are located in the folder specified in the "pageFolder" setting from your settings.json file.
The page naming convention I use is : `YYYY-MM-DD-title-of-article.md` which can translate into `2012-11-25-hello-world.md`
@@ -140,11 +140,16 @@ The file is self explanitory, the title is the title of your article, the date,
I am running my own blog using Almanac : [matthewroach.me](http://matthewroach.me) on a VS0 Mini VPS from [HostMedia UK](http://gigaw.at/?/z739049)
+# License
+
+Release under GNU General Public License, version 3 (GPL-3.0) - See [license.txt](license.txt)
+
+
#### Credits
Help with coming up with the name to follow along with my obsession of Back to the Future names for projects : [Stuart Robson - alwaystwisted.com](http://www.alwaystwisted.com/ "Slightly Bizarre Ramblings Of A Front-End Developer")
-My amazing wife [@pamelaroach](http://twitter.com/pamelaroach) for being supportive and proof reading for me
+My amazing wife [@pamelaroach](http://twitter.com/pamelaroach) for being supportive and proof reading for me

0 comments on commit b4b1ac9

Please sign in to comment.