2014-04-26 21:43:13 +00:00
|
|
|
```
|
2020-03-21 22:47:34 +00:00
|
|
|
_________.__ .__ .__ ________
|
|
|
|
/ _____/| |__ |__| _____ _____ |__| ____ \_____ \
|
|
|
|
\_____ \ | | \ | | / \ / \ | |_/ __ \ / ____/
|
|
|
|
/ \| Y \| || Y Y \| Y Y \| |\ ___/ / \
|
|
|
|
/_______ /|___| /|__||__|_| /|__|_| /|__| \___ >\_______ \
|
|
|
|
\/ \/ \/ \/ \/ \/
|
|
|
|
|
2014-04-26 21:43:13 +00:00
|
|
|
```
|
2012-02-12 19:40:38 +00:00
|
|
|
|
2014-04-26 21:52:31 +00:00
|
|
|
# Shimmie
|
2014-04-26 21:43:13 +00:00
|
|
|
|
2020-03-22 15:31:53 +00:00
|
|
|
[![Test & Publish](https://github.com/shish/shimmie2/workflows/Test%20&%20Publish/badge.svg)](https://github.com/shish/shimmie2/actions)
|
2020-02-14 11:31:13 +00:00
|
|
|
[![Code Quality](https://scrutinizer-ci.com/g/shish/shimmie2/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/shish/shimmie2/?branch=master)
|
2016-06-19 16:41:40 +00:00
|
|
|
[![Code Coverage](https://scrutinizer-ci.com/g/shish/shimmie2/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/shish/shimmie2/?branch=master)
|
|
|
|
|
2014-04-26 21:52:31 +00:00
|
|
|
This is the main branch of Shimmie, if you know anything at all about running
|
|
|
|
websites, this is the version to use.
|
2014-04-26 21:47:14 +00:00
|
|
|
|
2014-04-26 21:52:31 +00:00
|
|
|
Alternatively if you want a version that will never have significant changes,
|
|
|
|
check out one of the versioned branches.
|
2007-04-16 11:58:25 +00:00
|
|
|
|
2012-08-15 09:43:28 +00:00
|
|
|
|
2020-03-22 15:49:55 +00:00
|
|
|
# Documentation
|
2012-08-15 19:42:56 +00:00
|
|
|
|
2020-03-22 15:49:55 +00:00
|
|
|
* [Install straight on disk](https://github.com/shish/shimmie2/tree/master/docs/INSTALL.md)
|
|
|
|
* [Install in docker container](https://github.com/shish/shimmie2/tree/master/docs/DOCKER.md)
|
|
|
|
* [Upgrade process](https://github.com/shish/shimmie2/tree/master/docs/UPGRADE.md)
|
|
|
|
* [Advanced config](https://github.com/shish/shimmie2/tree/master/docs/CONFIG.md)
|
|
|
|
* [Developer notes](https://github.com/shish/shimmie2/tree/master/docs/DEV.md)
|
|
|
|
* [High-performance notes](https://github.com/shish/shimmie2/tree/master/docs/SPEED.md)
|
2010-07-07 12:02:27 +00:00
|
|
|
|
|
|
|
|
2014-04-26 21:52:31 +00:00
|
|
|
# Contact
|
2014-04-26 21:43:13 +00:00
|
|
|
|
|
|
|
Email: webmaster at shishnet.org
|
|
|
|
|
|
|
|
Issue/Bug tracker: http://github.com/shish/shimmie2/issues
|
2007-04-16 11:58:25 +00:00
|
|
|
|
|
|
|
|
2014-04-26 21:52:31 +00:00
|
|
|
# Licence
|
2014-04-26 21:43:13 +00:00
|
|
|
|
|
|
|
All code is released under the [GNU GPL Version 2](http://www.gnu.org/licenses/gpl-2.0.html) unless mentioned otherwise.
|
|
|
|
|
2016-06-19 16:41:40 +00:00
|
|
|
If you give shimmie to someone else, you have to give them the source (which
|
|
|
|
should be easy, as PHP is an interpreted language...). If you want to add
|
|
|
|
customisations to your own site, then those customisations belong to you,
|
|
|
|
and you can do what you want with them.
|