diff options
author | Aaron Parecki <aaron@parecki.com> | 2016-12-17 14:56:39 -0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2016-12-17 14:56:39 -0800 |
commit | 22630f4af335f671ad082dd035759c9ff44b23fc (patch) | |
tree | 73d93fe9324f7d87535c36dc602188a588b3cd69 | |
parent | 836929fd2b2d7caa33213ce832369c6fdc33fe57 (diff) | |
parent | d710ed760f308783a133b311bc60075aa69c5aed (diff) |
Merge pull request #52 from cweiske/master
Add installation instructions
-rw-r--r-- | README.md | 33 |
1 files changed, 19 insertions, 14 deletions
@@ -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 |