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

Go to a project
Toggle navigation
Toggle navigation pinning
Dan Brown
b498b60c 1 parent b97d5704

Updated readme with simpler instructions

Inline Side-by-side
Showing 1 changed file with 17 additions and 12 deletions
...@@ -2,35 +2,40 @@ ...@@ -2,35 +2,40 @@
2 2
3 A platform to create documentation/wiki content. General information about BookStack can be found at https://www.bookstackapp.com/ 3 A platform to create documentation/wiki content. General information about BookStack can be found at https://www.bookstackapp.com/
4 4
5 -**BookStack is currently in rapid development so use now is heavily cautioned as future updates my break existing installations.**
6 5
7 ## Requirements 6 ## Requirements
8 7
9 -BookStack has the similar requirements to Laravel. On top of those are some front-end build tools which the requirement of will be removed once out of beta release. 8 +BookStack has the similar requirements to Laravel. On top of those are some front-end build tools which are only required when developing.
10 9
11 * PHP >= 5.5.9 10 * PHP >= 5.5.9
12 * OpenSSL PHP Extension 11 * OpenSSL PHP Extension
13 * PDO PHP Extension 12 * PDO PHP Extension
14 -* Mbstring PHP Extension 13 +* MBstring PHP Extension
15 * Tokenizer PHP Extension 14 * Tokenizer PHP Extension
16 * MySQL >= 5.6 15 * MySQL >= 5.6
16 +* Git (Not strictly required but helps manage updates)
17 * [Composer](https://getcomposer.org/) 17 * [Composer](https://getcomposer.org/)
18 -* [Node.js](https://nodejs.org/en/) **To be removed in future** 18 +* [Node.js](https://nodejs.org/en/) **Development Only**
19 -* [Bower](http://bower.io/) **To be removed in future** 19 +* [Gulp](http://gulpjs.com/) **Development Only**
20 -* [Gulp](http://gulpjs.com/) **To be removed in future**
21 20
22 21
23 ## Installation 22 ## Installation
24 23
25 Ensure the requirements are met before installing. 24 Ensure the requirements are met before installing.
26 25
27 -The installation is currently somewhat complicated. Some PHP/Laravel experience will benefit. This will be streamlined in the future. 26 +This project currently uses the `release` branch of this repository as a stable channel for providing updates.
28 27
29 -1. Clone the repository into a folder. 28 +The installation is currently somewhat complicated. Some PHP/Laravel experience will benefit.
30 -2. `cd` into folder and run `composer install` followed by `npm install` and `bower install`. 29 +
31 -3. Run `gulp --production` to compile the JavaScript and css files. 30 +1. Clone the release branch of this repository into a folder.
32 -4. Copy the `.env.example` file to `.env` and fill with your own database and mail details. 31 +
33 -5. Ensure the `storage` & `bootstrap/cache` folders are writable by the web server. 32 +```
33 +git clone https://github.com/ssddanbrown/BookStack.git --branch release --single-branch
34 +```
35 +
36 +2. `cd` into the application folder and run `composer install`.
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.
34 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.
35 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 `.htaccess` files are disable you will have to create some URL rewrite rules as shown below.
36 7. Run `php migrate` to update the database. 41 7. Run `php migrate` to update the database.
......