From 936d3d20db7d10aa02e6e09c61c1073a90513aaa Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 30 Dec 2020 13:55:16 +0100 Subject: [PATCH 1/2] Add a readme file to the repo. --- README | 1 - README.md | 31 +++++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+), 1 deletion(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 50cb4c31..00000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -This marks the development repository for the HashRU website. diff --git a/README.md b/README.md new file mode 100644 index 00000000..6bdbbff5 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# HashRU Pics + +This is the development repository for the HashRU photo website. +The CMS and its modules originate in [Kabuki CMS](https://aaronweb.net/projects/kabuki/), but have been extended and are maintained separately in this repository. + +## Requirements + +The Kabuki codebase requires the following PHP extensions to be enabled for full operation: + +* exif +* imagick (PECL) +* mysqli + +## Setup + +Copy `config.php.dist` to `config.php` and set-up the constants contained in the file. + +## Running + +For development purposes, simply run the `server` script provided in the root of this repository. +This will start a PHP development server on `hashru.local:8080`. + +For a production environment, please set up a proper PHP-FPM environment instead. + +## Contributing + +Pull requests are welcome over at the [HashRU Gitea](https://gitea.hashru.nl/Public/pics/pulls). + +## License + +The HashRU Pics repository is licensed with a BSD 3-clause license, as is Kabuki CMS. From 3594b3d0214c146ad8fb26a47c06813650155ab9 Mon Sep 17 00:00:00 2001 From: Aaron van Geffen Date: Wed, 30 Dec 2020 13:55:30 +0100 Subject: [PATCH 2/2] Add BSD 3-clause license. --- LICENSE.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..29eff27c --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,11 @@ +Copyright 2016-2021 Stichting HashRU + +Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + +2. 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. + +3. Neither the name of the copyright holder 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.