From f4b342a575e6f8e62a12ee8f611faba1cb6906f8 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Wed, 16 Dec 2015 14:54:29 +0000 Subject: [PATCH] Updated readme with fixes and attribution --- readme.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 7b4a20c6d..2d4c84b3b 100644 --- a/readme.md +++ b/readme.md @@ -5,7 +5,7 @@ A platform to create documentation/wiki content. General information about BookS ## Requirements -BookStack has the similar requirements to Laravel. On top of those are some front-end build tools which are only required when developing. +BookStack has similar requirements to Laravel. On top of those are some front-end build tools which are only required when developing. * PHP >= 5.5.9 * OpenSSL PHP Extension @@ -25,11 +25,11 @@ Ensure the requirements are met before installing. This project currently uses the `release` branch of this repository as a stable channel for providing updates. -The installation is currently somewhat complicated. Some PHP/Laravel experience will benefit. +The installation is currently somewhat complicated and will be made simpler in future releases. Some PHP/Laravel experience will currently benefit. 1. Clone the release branch of this repository into a folder. -``` +``` git clone https://github.com/ssddanbrown/BookStack.git --branch release --single-branch ``` @@ -37,7 +37,7 @@ git clone https://github.com/ssddanbrown/BookStack.git --branch release --single 3. Copy the `.env.example` file to `.env` and fill with your own database and mail details. 4. Ensure the `storage` & `bootstrap/cache` folders are writable by the web server. 5. In the application root, Run `php artisan key:generate` to generate a unique application key. -6. If not using apache or `.htaccess` files are disable you will have to create some URL rewrite rules as shown below. +6. If not using apache or if `.htaccess` files are disabled you will have to create some URL rewrite rules as shown below. 7. Run `php migrate` to update the database. 8. Done! You can now login using the default admin details `admin@admin.com` with a password of `password`. It is recommended to change these details directly after first logging in. @@ -76,3 +76,17 @@ Once done you can run `phpunit` in the application root directory to run all tes ## License BookStack is provided under the MIT License. + +## Attribution + +These are the great projects used to help build BookStack: + +* [Laravel](http://laravel.com/) +* [VueJS](http://vuejs.org/) +* [jQuery](https://jquery.com/) +* [TinyMCE](https://www.tinymce.com/) +* [highlight.js](https://highlightjs.org/) +* [jQuery Sortable](https://johnny.github.io/jquery-sortable/) +* [Material Design Iconic Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html) +* [Dropzone.js](http://www.dropzonejs.com/) +* [ZeroClipboard](http://zeroclipboard.org/)