From d710ed760f308783a133b311bc60075aa69c5aed Mon Sep 17 00:00:00 2001 From: Christian Weiske Date: Fri, 29 Jul 2016 07:39:38 +0200 Subject: [PATCH] Add installation instructions --- README.md | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index c5c7b47..573ccbb 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,26 @@ Quill ===== +[Micropub](http://micropub.net/draft/) client written in PHP. Work in progress. Do not use! https://quill.p3k.io/ +## Dependencies +- PHP +- MySQL or SQLite +- Composer for further dependency installation + + +## Setup +- Follow the "Web Server Configuration" section +- Run `composer install` +- Copy `lib/config.template.php` to `lib/config.php` and adjust it +- Import `schema/mysql.sql` (or `schema/sqlite.sql`) +- Open the Quill URL in your Browser + + ### Web Server Configuration Set the document root to the "public" folder of this repo, and ensure all requests are routed through `public/index.php` if they don't match a file. @@ -32,18 +47,8 @@ server { } ``` -#### Apache htaccess - -``` - RewriteEngine on - - RewriteBase / - - RewriteCond %{REQUEST_FILENAME} !-f - RewriteCond %{REQUEST_FILENAME} !-d - RewriteCond %{REQUEST_URI} !=/favicon.ico - RewriteRule ^ index.php [L] -``` +#### Apache .htaccess +An `.htacces` file is already located in the `public/` folder. ### Contributing @@ -51,12 +56,12 @@ server { By submitting code to this project, you agree to irrevocably release it under the same license as this project. -### Credits +## Credits Quill icon designed by [Juan Pablo Bravo from the Noun Project](http://thenounproject.com/term/quill/17013/). -### License +## License Copyright 2013 by Aaron Parecki