36 lines
1.7 KiB
Markdown
36 lines
1.7 KiB
Markdown
```
|
|
_________.__ .__ .__ ________
|
|
/ _____/| |__ |__| _____ _____ |__| ____ \_____ \
|
|
\_____ \ | | \ | | / \ / \ | |_/ __ \ / ____/
|
|
/ \| Y \| || Y Y \| Y Y \| |\ ___/ / \
|
|
/_______ /|___| /|__||__|_| /|__|_| /|__| \___ >\_______ \
|
|
\/ \/ \/ \/ \/ \/
|
|
|
|
```
|
|
|
|
# Shimmie
|
|
|
|
[![Tests](https://github.com/shish/shimmie2/workflows/Tests/badge.svg?branch=main)](https://github.com/shish/shimmie2/actions)
|
|
[![Matrix](https://matrix.to/img/matrix-badge.svg)](https://matrix.to/#/#shimmie:matrix.org)
|
|
|
|
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/shish/shimmie2?quickstart=1)
|
|
|
|
# Documentation
|
|
|
|
* [Install straight on disk](https://github.com/shish/shimmie2/wiki/Install)
|
|
* [Install in docker container](https://github.com/shish/shimmie2/wiki/Docker)
|
|
* [Upgrade process](https://github.com/shish/shimmie2/wiki/Upgrade)
|
|
* [Basic settings](https://github.com/shish/shimmie2/wiki/Settings)
|
|
* [Advanced config](https://github.com/shish/shimmie2/wiki/Advanced-Config)
|
|
* [Developer notes](https://github.com/shish/shimmie2/wiki/Development-Info)
|
|
* [High-performance notes](https://github.com/shish/shimmie2/wiki/Performance)
|
|
|
|
|
|
# Licence
|
|
|
|
All code is released under the [GNU GPL Version 2](https://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.
|