85 lines
2.8 KiB
Text
85 lines
2.8 KiB
Text
|
|
_________.__ .__ .__ ________
|
|
/ _____/| |__ |__| _____ _____ |__| ____ \_____ \
|
|
\_____ \ | | \| |/ \ / \| |/ __ \ / ____/
|
|
/ \| Y \ | Y Y \ Y Y \ \ ___// \
|
|
/_______ /|___| /__|__|_| /__|_| /__|\___ >_______ \
|
|
\/ \/ \/ \/ \/ \/
|
|
|
|
Shimmie Alpha
|
|
~~~~~~~~~~~~~
|
|
If you're reading this on github and looking for the stable version, go
|
|
to the top of the page -> switch branches -> pick a stable branch. To do
|
|
similarly with a git clone, "git checkout -b my_2.X origin/branch_2.X"
|
|
|
|
This code is for people who want to write extensions compatible with the
|
|
next version of shimmie. You can run a production site with it if you're
|
|
feeling brave, but it's not recommended.
|
|
|
|
If there is a feature here, and not in the stable branch, that's probably
|
|
because the feature doesn't work yet :P
|
|
|
|
|
|
Requirements
|
|
~~~~~~~~~~~~
|
|
MySQL 4.1+ (with experimental support for PostgreSQL 8+ and SQLite 3)
|
|
PHP 5.2+
|
|
GD or ImageMagick
|
|
|
|
|
|
Installation
|
|
~~~~~~~~~~~~
|
|
1) Create a blank database
|
|
2) Unzip shimmie into a folder on the web host
|
|
3) Visit the folder with a web browser
|
|
4) Enter the location of the database
|
|
5) Click "install". Hopefully you'll end up at the welcome screen; if
|
|
not, you should be given instructions on how to fix any errors~
|
|
|
|
|
|
Upgrade from 2.3.X
|
|
~~~~~~~~~~~~~~~~~~
|
|
The database connection setting in config.php has changed; now using
|
|
PDO DSN format rather than ADODB URI:
|
|
|
|
OLD: $database_dsn = "<proto>://<username>:<password>@<host>/<database>";
|
|
NEW: define("DATABASE_DSN", "<proto>:user=<username>;password=<password>;host=<host>;dbname=<database>");
|
|
|
|
The rest should be automatic, just unzip into a clean folder and copy across
|
|
config.php, images and thumbs folders from the old version. This
|
|
includes automatically messing with the database -- back it up first!
|
|
|
|
|
|
Upgrade from earlier versions
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
I very much recommend going via each major release in turn (eg, 2.0.6
|
|
-> 2.1.3 -> 2.2.4 -> 2.3.0 rather than 2.0.6 -> 2.3.0). While the basic
|
|
database and file formats haven't changed *completely*, it's different
|
|
enough to be a pain.
|
|
|
|
|
|
Development Info
|
|
~~~~~~~~~~~~~~~~
|
|
http://shimmie.shishnet.org/doc/
|
|
|
|
Please tell me if those docs are lacking in any way, so that they can be
|
|
improved for the next person who uses them
|
|
|
|
|
|
Contact
|
|
~~~~~~~
|
|
#shimmie on Freenode -- IRC
|
|
webmaster at shishnet.org -- email
|
|
https://github.com/shish/shimmie2 -- bug tracker
|
|
|
|
|
|
Licence
|
|
~~~~~~~
|
|
All code is GPLv2 unless mentioned otherwise; ie, 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.
|
|
|
|
|
|
|