48 lines
2.1 KiB
Markdown
48 lines
2.1 KiB
Markdown
```
|
|
_________.__ .__ .__ ________
|
|
/ _____/| |__ |__| _____ _____ |__| ____ \_____ \
|
|
\_____ \ | | \ | | / \ / \ | |_/ __ \ / ____/
|
|
/ \| Y \| || Y Y \| Y Y \| |\ ___/ / \
|
|
/_______ /|___| /|__||__|_| /|__|_| /|__| \___ >\_______ \
|
|
\/ \/ \/ \/ \/ \/
|
|
|
|
```
|
|
|
|
# Shimmie
|
|
|
|
[](https://github.com/shish/shimmie2/actions)
|
|
[](https://scrutinizer-ci.com/g/shish/shimmie2/?branch=master)
|
|
[](https://scrutinizer-ci.com/g/shish/shimmie2/?branch=master)
|
|
|
|
This is the main branch of Shimmie, if you know anything at all about running
|
|
websites, this is the version to use.
|
|
|
|
Alternatively if you want a version that will never have significant changes,
|
|
check out one of the versioned branches.
|
|
|
|
|
|
# Documentation
|
|
|
|
* [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)
|
|
|
|
|
|
# Contact
|
|
|
|
Email: webmaster at shishnet.org
|
|
|
|
Issue/Bug tracker: http://github.com/shish/shimmie2/issues
|
|
|
|
|
|
# Licence
|
|
|
|
All code is released under the [GNU GPL Version 2](http://www.gnu.org/licenses/gpl-2.0.html) unless mentioned otherwise.
|
|
|
|
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.
|