Зуев Егор / wiki.dev

Go to a project
Toggle navigation
Toggle navigation pinning
Dan Brown
f4b342a5 1 parent 497747e6

Updated readme with fixes and attribution

Inline Side-by-side
Showing 1 changed file with 18 additions and 4 deletions
...@@ -5,7 +5,7 @@ A platform to create documentation/wiki content. General information about BookS ...@@ -5,7 +5,7 @@ A platform to create documentation/wiki content. General information about BookS
5 5
6 ## Requirements 6 ## Requirements
7 7
8 -BookStack has the similar requirements to Laravel. On top of those are some front-end build tools which are only required when developing. 8 +BookStack has similar requirements to Laravel. On top of those are some front-end build tools which are only required when developing.
9 9
10 * PHP >= 5.5.9 10 * PHP >= 5.5.9
11 * OpenSSL PHP Extension 11 * OpenSSL PHP Extension
...@@ -25,11 +25,11 @@ Ensure the requirements are met before installing. ...@@ -25,11 +25,11 @@ Ensure the requirements are met before installing.
25 25
26 This project currently uses the `release` branch of this repository as a stable channel for providing updates. 26 This project currently uses the `release` branch of this repository as a stable channel for providing updates.
27 27
28 -The installation is currently somewhat complicated. Some PHP/Laravel experience will benefit. 28 +The installation is currently somewhat complicated and will be made simpler in future releases. Some PHP/Laravel experience will currently benefit.
29 29
30 1. Clone the release branch of this repository into a folder. 30 1. Clone the release branch of this repository into a folder.
31 31
32 -``` 32 +```
33 git clone https://github.com/ssddanbrown/BookStack.git --branch release --single-branch 33 git clone https://github.com/ssddanbrown/BookStack.git --branch release --single-branch
34 ``` 34 ```
35 35
...@@ -37,7 +37,7 @@ git clone https://github.com/ssddanbrown/BookStack.git --branch release --single ...@@ -37,7 +37,7 @@ git clone https://github.com/ssddanbrown/BookStack.git --branch release --single
37 3. Copy the `.env.example` file to `.env` and fill with your own database and mail details. 37 3. Copy the `.env.example` file to `.env` and fill with your own database and mail details.
38 4. Ensure the `storage` & `bootstrap/cache` folders are writable by the web server. 38 4. Ensure the `storage` & `bootstrap/cache` folders are writable by the web server.
39 5. In the application root, Run `php artisan key:generate` to generate a unique application key. 39 5. In the application root, Run `php artisan key:generate` to generate a unique application key.
40 -6. If not using apache or `.htaccess` files are disable you will have to create some URL rewrite rules as shown below. 40 +6. If not using apache or if `.htaccess` files are disabled you will have to create some URL rewrite rules as shown below.
41 7. Run `php migrate` to update the database. 41 7. Run `php migrate` to update the database.
42 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. 42 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.
43 43
...@@ -76,3 +76,17 @@ Once done you can run `phpunit` in the application root directory to run all tes ...@@ -76,3 +76,17 @@ Once done you can run `phpunit` in the application root directory to run all tes
76 ## License 76 ## License
77 77
78 BookStack is provided under the MIT License. 78 BookStack is provided under the MIT License.
79 +
80 +## Attribution
81 +
82 +These are the great projects used to help build BookStack:
83 +
84 +* [Laravel](http://laravel.com/)
85 +* [VueJS](http://vuejs.org/)
86 +* [jQuery](https://jquery.com/)
87 +* [TinyMCE](https://www.tinymce.com/)
88 +* [highlight.js](https://highlightjs.org/)
89 +* [jQuery Sortable](https://johnny.github.io/jquery-sortable/)
90 +* [Material Design Iconic Font](http://zavoloklom.github.io/material-design-iconic-font/icons.html)
91 +* [Dropzone.js](http://www.dropzonejs.com/)
92 +* [ZeroClipboard](http://zeroclipboard.org/)
......