diff options
| -rw-r--r-- | CONTRIBUTORS | 6 | ||||
| -rw-r--r-- | COPYING | 3 | ||||
| -rw-r--r-- | INSTALL.md | 58 | ||||
| -rw-r--r-- | README.md | 34 | ||||
| -rw-r--r-- | ratatoeskr/licenses/ratatoeskr | 2 | ||||
| -rwxr-xr-x | ratatoeskr/templates/src/systemtemplates/backend_login.html | 2 | ||||
| -rwxr-xr-x | ratatoeskr/templates/src/systemtemplates/master.html | 2 |
7 files changed, 104 insertions, 3 deletions
diff --git a/CONTRIBUTORS b/CONTRIBUTORS new file mode 100644 index 0000000..eb521ac --- /dev/null +++ b/CONTRIBUTORS @@ -0,0 +1,6 @@ +People who have worked on r7r_repo +================================== + +If you modified something, feel free to append your name to this list. + +* Kevin Chabowski <kevin@kch42.de> @@ -0,0 +1,3 @@ +Ratatöskr is licensed under the X11/MIT license for free software. + +See /ratatoeskr/licenses/ratatoeskr for more details. diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..8d50ddb --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,58 @@ +Installing Ratatöskr +==================== + +Step 0: Requirements +-------------------- + +* Apache Webserver with PHP 5.3 +* These PHP modules (usually installed): gd, hash, session, mysql +* A MySQL server. + +Step 1: Get additional libraries +-------------------------------- + +You need these libraries to run Ratatöskr (it is probably already bundled with these): + +1. Stupid Template Engine (STE) + + Place "stupid_template_engine.php" directly into this directory. + + STE can be found here: <https://github.com/kch42/Stupid-Template-Engine> + +2. PHP Markdown + + Place "markdown.php" from the archive directly into this directory. + + PHP Markdown can be found here: <http://michelf.com/projects/php-markdown/> + +3. kses + + Place "kses.php" from the archive directly into this directory. + + kses can be found at <http://sourceforge.net/projects/kses/> + +Step 2: Copy files to your Webspace +----------------------------------- + +Copy Ratatöskr to your webspace (usually using FTP or SFTP). + +Step 3: Use the setup wizard +---------------------------- + +1. Open your favourite Web browser and surf to `setup.php` of your Ratatöskr installation. + +2. * If the wizard is complaining about some unmet requirements, your server is probably not capable of running Ratatöskr. Sorry :-(. + * If the wizard is complaining about missing directories, create them. + * If the wizard is complaining about missing files, check, if you uploaded everything. + * If the wizard is complaining about missing writing permissions, give the Webserver writing permissions to these directories. + +3. Choose your language. + +4. Enter the MySQL connection details and the desired username and password for the admin account. + +5. Copy the text from the textbox and replace the contents of `/ratatoeskr/config.php` with it. + +Step 4: Delete the setup wizard +------------------------------- + +Delete the file `setup.php`. diff --git a/README.md b/README.md new file mode 100644 index 0000000..aeba9f0 --- /dev/null +++ b/README.md @@ -0,0 +1,34 @@ +Ratatöskr +========= + +Ratatöskr is a flexible Content Management System / Blogging Software for PHP 5.3. + +Why you should use Ratatöskr +---------------------------- + +* You want to modify the appearance of your Website fairly easily. +* You want to publish your content in multiple languages. +* You want to write powerful plugins using a simple API. + +Possible reasons against Ratatöskr +---------------------------------- + +* Early development. So probably a lot of bugs. +* It will probably perform badly on websites with a lot of page hits (many SQL queries per page request). +* You do not want to write your own templates. Because templates define a lot of the page's behaviour, pre-build templates will probably not meet your needs. Ratatöskr focusses on individual page designs. +* You have a large team that manages the website. Ratatöskr has multi-user support, but there are no access control lists or something like that. + +Wish List +--------- + +* Better multi-user support (e.g. access control lists) +* Version management of articles. + +What does "Ratatöskr" mean? +--------------------------- + +> In Norse mythology, Ratatoskr \[*also spelled* **Ratatöskr**\] is a squirrel who runs up and down the world tree Yggdrasil to carry messages between the unnamed eagle, perched atop Yggdrasil, and the wyrm Níðhöggr, who dwells beneath one of the three roots of the tree. + +Source: [http://en.wikipedia.org/wiki/Ratatöskr](http://en.wikipedia.org/wiki/Ratatöskr) + +Because Ratatöskr delivers messages, I thought it was a good name for a CMS / Blog-Software, which also delivers messages / news. Plus squirrels are cool animals :-). diff --git a/ratatoeskr/licenses/ratatoeskr b/ratatoeskr/licenses/ratatoeskr index c0dc1c0..1483299 100644 --- a/ratatoeskr/licenses/ratatoeskr +++ b/ratatoeskr/licenses/ratatoeskr @@ -1,4 +1,4 @@ -Copyright (c) 2011 Kevin Chabowski +Copyright (c) 2011 The Ratatöskr Team Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/ratatoeskr/templates/src/systemtemplates/backend_login.html b/ratatoeskr/templates/src/systemtemplates/backend_login.html index 4344461..aebed4a 100755 --- a/ratatoeskr/templates/src/systemtemplates/backend_login.html +++ b/ratatoeskr/templates/src/systemtemplates/backend_login.html @@ -9,7 +9,7 @@ <body> <img id="background_image" src="$rel_path_to_root/ratatoeskr/cms_style/images/login_bg.jpg" alt="" /> <div id="main"> - <div id="bar_top"><strong>Ratatöskr</strong>::Noctilucent clouds (v. 0.1 α)</div> + <div id="bar_top"><strong>Ratatöskr</strong>::Noctilucent clouds (v. 0.1 β)</div> <div class="vcenter_outer"><div class="vcenter_inner"> <div id="login_box"> <h1><ste:get_translation for="login_form_header" /></h1> diff --git a/ratatoeskr/templates/src/systemtemplates/master.html b/ratatoeskr/templates/src/systemtemplates/master.html index 67207b9..d1328d9 100755 --- a/ratatoeskr/templates/src/systemtemplates/master.html +++ b/ratatoeskr/templates/src/systemtemplates/master.html @@ -24,7 +24,7 @@ </head> <body> <div id="bar_top"> - <span class="branding"><strong>Ratatöskr</strong>::Noctilucent clouds (v. 0.1 α)</span> + <span class="branding"><strong>Ratatöskr</strong>::Noctilucent clouds (v. 0.1 β)</span> <span class="user"> <a href="$rel_path_to_root/backend/admin/users/u/$user[id]">$user[name]</a> | <a href="$rel_path_to_root/backend/logout"><ste:get_translation for="logout" /></a> </span> |