Merge branch 'release/1.0.0'

futape · Feb 21, 2015 · 70d04aa · 70d04aa
2 parents b85395d + 011205b
commit 70d04aa
Show file tree

Hide file tree

Showing 21 changed files with 102 additions and 20 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@ It provides everything you need to run a blog or any other website - From a stat
 Moreover the project is well documented and provides lots of information on getting started and getting better with Gustav in the [GitHub Wiki](https://github.com/futape/gustav/wiki).  
 For those that just want to set up Gustav quickly, click [here](https://github.com/futape/gustav/wiki/Getting-started). Others may want to read the full [documentation](https://github.com/futape/gustav/wiki) to get more information.
 
-A demo of Gustav running in a production environment is avaiable on <http://gustav.futape.de>. The source code for that website is also [available on GitHub](https://github.com/futape/gustav.futape.de). Feel free to fork the repository and play around with the example code.
+A demo of Gustav running in a production environment is avaiable on <http://demo.gustav.futape.de>. The source code for that website is also [available on GitHub](https://github.com/futape/demo.gustav.futape.de). Feel free to fork the repository and play around with the example code.
 
 
 
@@ -39,7 +39,11 @@ A list of releases can be seen [here](https://github.com/futape/gustav/releases)
 
 ##License
 
-Gustav is published under the permissive [*BSD New* Open-Source-License](http://opensource.org/licenses/BSD-3-Clause).
+The Gustav source is published under the permissive [*New* BSD Open-Source-License](http://opensource.org/licenses/BSD-3-Clause).  
+A [copy of that license](https://github.com/futape/gustav/blob/master/src/futape/gustav/LICENSE) is located under `src/futape/gustav`.
+
+Any other content like the Gustav logo or the documentation is, if not otherwise stated, published under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).  
+<a href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" border="0" src="https://i.creativecommons.org/l/by/4.0/80x15.png" /></a>
 
 
 

diff --git a/doc/Home.md b/doc/Home.md
@@ -2,7 +2,14 @@
 
 <img src="https://raw.githubusercontent.com/futape/gustav/master/misc/Gustav.png" alt="Gustav Logo" width="200" />
 
-*Gustav* is a powerful static-site gernerator written in PHP.
+[*Gustav*](http://gustav.futape.de) is a powerful static-site gernerator written in PHP.
+
+It provides everything you need to run a blog or any other website - From a static-site generator offering a robust templating system and a great customizability to a massive PHP API providing functions for searching the published articles and pages, getting available tags and categories, and more, as well as hooks that can be used to extend Gustav's functionality.
+
+This documentation provides lots of information on getting started and getting better with Gustav.  
+For those that just want to set up Gustav quickly, click [here](Getting-started). Others may want to read the full documentation to get more information.
+
+A demo of Gustav running in a production environment is avaiable on <http://demo.gustav.futape.de>. The source code for that website is also [available on GitHub](https://github.com/futape/demo.gustav.futape.de). Feel free to fork the repository and play around with the example code.
 
 
 
@@ -36,6 +43,30 @@
 
 
 
+##License
+
+This documentation is part of the [Gustav project](http://gustav.futape.de). See that project for license information.
+
+
+
+##Support
+
+<a href="https://flattr.com/submit/auto?user_id=lucaskrause&url=https%3A%2F%2Fgithub.com%2Ffutape%2Fgustav" target="_blank"><img src="http://button.flattr.com/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a>
+
+
+
+##Contributing
+
+For information on contributing to this documentation, see the [`CONTRIBUTING.md`](https://github.com/futape/gustav/blob/master/CONTRIBUTING.md) file in the Gustav repository.
+
+
+
 ##Author
 
-Lucas Krause ([@futape](https://twitter.com/futape))
+<table><tbody><tr><td>
+    <img src="http://www.gravatar.com/avatar/118bcae2fda8b302155ad47a2bfda556.png?s=100&amp;d=monsterid" />
+</td><td>
+    Lucas Krause (<a href="https://twitter.com/futape">@futape</a>)
+</td></tr></tbody></table>
+
+For a full list of contributors to the Gustav source and/or this documentation, click [here](https://github.com/futape/gustav/graphs/contributors).
diff --git a/src/futape/gustav/Gustav.php b/src/futape/gustav/Gustav.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavBase.php"));

diff --git a/src/futape/gustav/GustavBase.php b/src/futape/gustav/GustavBase.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 //use BadMethodCallException; //used by __callStatic()

diff --git a/src/futape/gustav/GustavBaseHooks.php b/src/futape/gustav/GustavBaseHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavBase.php"));

diff --git a/src/futape/gustav/GustavBlock.php b/src/futape/gustav/GustavBlock.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));

diff --git a/src/futape/gustav/GustavBlockHooks.php b/src/futape/gustav/GustavBlockHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavBlock.php"));

diff --git a/src/futape/gustav/GustavContent.php b/src/futape/gustav/GustavContent.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));

diff --git a/src/futape/gustav/GustavContentHooks.php b/src/futape/gustav/GustavContentHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavContent.php"));

diff --git a/src/futape/gustav/GustavDest.php b/src/futape/gustav/GustavDest.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));

diff --git a/src/futape/gustav/GustavDestHooks.php b/src/futape/gustav/GustavDestHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavDest.php"));

diff --git a/src/futape/gustav/GustavGenerator.php b/src/futape/gustav/GustavGenerator.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));

diff --git a/src/futape/gustav/GustavGeneratorHooks.php b/src/futape/gustav/GustavGeneratorHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavGenerator.php"));

diff --git a/src/futape/gustav/GustavHooks.php b/src/futape/gustav/GustavHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));
@@ -39,4 +41,4 @@ public static function __callStatic($str_fn, $arr_args){
 
 
 
-}
+}
diff --git a/src/futape/gustav/GustavMatch.php b/src/futape/gustav/GustavMatch.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));

diff --git a/src/futape/gustav/GustavMatchHooks.php b/src/futape/gustav/GustavMatchHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavMatch.php"));

diff --git a/src/futape/gustav/GustavSrc.php b/src/futape/gustav/GustavSrc.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));

diff --git a/src/futape/gustav/GustavSrcHooks.php b/src/futape/gustav/GustavSrcHooks.php
@@ -1,4 +1,6 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 namespace futape\gustav;
 
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavSrc.php"));

diff --git a/src/futape/gustav/LICENSE b/src/futape/gustav/LICENSE
@@ -0,0 +1,27 @@
+Copyright (c) 2015, Lucas Krause <http://futape.de>
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of Gustav nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/src/futape/gustav/generate.php b/src/futape/gustav/generate.php
@@ -1,9 +1,11 @@
 <?php
+/*! Gustav 1.0.0 | Copyright (c) 2015 Lucas Krause | New BSD License | http://gustav.futape.de */
+
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "Gustav.php"));
 require_once implode(DIRECTORY_SEPARATOR, array(rtrim(__DIR__, DIRECTORY_SEPARATOR), "GustavGenerator.php"));
 
 use futape\gustav\Gustav;
 use futape\gustav\GustavGenerator;
 
 GustavGenerator::genByUrl($_SERVER['REQUEST_URI'], Gustav::getConf(Gustav::CONF_GEN_SEARCH_RECURSIVE));
-?>
+?>