]> BookStack Code Mirror - bookstack/blobdiff - readme.md
Update/fix german translation
[bookstack] / readme.md
index 3e269e1758d96a57f402b3538ee008c4e973fe05..5d099ad5fbace815efa1f8d9054aa9d06591cbbe 100644 (file)
--- a/readme.md
+++ b/readme.md
@@ -22,9 +22,12 @@ All development on BookStack is currently done on the master branch. When it's t
 SASS is used to help the CSS development and the JavaScript is run through browserify/babel to allow for writing ES6 code. Both of these are done using gulp. To run the build task you can use the following commands:
 
 ``` bash
-# Build and minify for production
+# Build assets for development
 npm run-script build
 
+# Build and minify assets for production
+npm run-script production
+
 # Build for dev (With sourcemaps) and watch for changes
 npm run-script dev
 ```
@@ -43,6 +46,8 @@ Once done you can run `phpunit` in the application root directory to run all tes
 ## Translations
 
 As part of BookStack v0.14 support for translations has been built in. All text strings can be found in the `resources/lang` folder where each language option has its own folder. To add a new language you should copy the `en` folder to an new folder (eg. `fr` for french) then go through and translate all text strings in those files, leaving the keys and file-names intact. If a language string is missing then the `en` translation will be used. To show the language option in the user preferences language drop-down you will need to add your language to the options found at the bottom of the `resources/lang/en/settings.php` file. A system-wide language can also be set in the `.env` file like so: `APP_LANG=en`.
+
+You will also need to add the language to the `locales` array in the `config/app.php` file.
  
  Some strings have colon-prefixed variables in such as `:userName`. Leave these values as they are as they will be replaced at run-time.
  
@@ -62,17 +67,19 @@ The BookStack source is provided under the MIT License.
 
 ## Attribution
 
-These are the great projects used to help build BookStack:
+These are the great open-source projects used to help build BookStack:
 
 * [Laravel](http://laravel.com/)
 * [AngularJS](https://angularjs.org/)
 * [jQuery](https://jquery.com/)
 * [TinyMCE](https://www.tinymce.com/)
-* [highlight.js](https://highlightjs.org/)
+* [CodeMirror](https://codemirror.net)
+* [Vue.js](http://vuejs.org/)
+* [Axios](https://github.com/mzabriskie/axios)
 * [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/)
+* [clipboard.js](https://clipboardjs.com/)
 * [TinyColorPicker](http://www.dematte.at/tinyColorPicker/index.html)
 * [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists)
 * [Moment.js](http://momentjs.com/)
@@ -82,5 +89,3 @@ These are the great projects used to help build BookStack:
     * [Snappy (WKHTML2PDF)](https://github.com/barryvdh/laravel-snappy)
     * [Laravel IDE helper](https://github.com/barryvdh/laravel-ide-helper)
 * [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html)
-
-Additionally, Thank you [BrowserStack](https://www.browserstack.com/) for supporting us and making cross-browser testing easy.