Browse Source

Add installation instructions

pull/52/head
Christian Weiske 8 years ago
parent
commit
d710ed760f
  1. 33
      README.md

33
README.md

@ -1,11 +1,26 @@
Quill Quill
===== =====
[Micropub](http://micropub.net/draft/) client written in PHP.
Work in progress. Do not use! Work in progress. Do not use!
https://quill.p3k.io/ 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 ### 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. 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 ### 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. 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/). Quill icon designed by [Juan Pablo Bravo from the Noun Project](http://thenounproject.com/term/quill/17013/).
### License
## License
Copyright 2013 by Aaron Parecki Copyright 2013 by Aaron Parecki

Loading…
Cancel
Save