diff --git a/README.md b/README.md index 5e1c397ad..5ee4c88cd 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![CDNJS](https://img.shields.io/cdnjs/v/admin-lte.svg)](https://cdnjs.com/libraries/admin-lte) [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/from-referrer/) -**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 4.4](https://getbootstrap.com/)** framework and also the JS/jQuery plugin. +**AdminLTE** is a fully responsive administration template. Based on **[Bootstrap 4.5](https://getbootstrap.com/)** framework and also the JS/jQuery plugin. Highly customizable and easy to use. Fits many screen resolutions from small mobile devices to large desktops. **Preview on [AdminLTE.io](https://adminlte.io/themes/v3)** @@ -24,9 +24,11 @@ SCSS has been used to increase code customizability. There are multiple ways to install AdminLTE. -### Download: +### Download & Changelog: -Download from [GitHub releases](https://github.com/ColorlibHQ/AdminLTE/releases). +Download from GitHub latest release [AdminLTE 3](https://github.com/ColorlibHQ/AdminLTE/latest). +Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog. +Legacy Releases are [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18) / [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1). ### Using The Command Line: @@ -63,37 +65,38 @@ _**Important Note**: To install it via npm/Yarn, you need at least Node.js 10 or Visit the [online documentation](https://adminlte.io/docs/3.0/) for the most updated guide. Information will be added on a weekly basis. -## Browser Support +## Browsers support -- IE 10+ -- Firefox (latest) -- Chrome (latest) -- Safari (latest) -- Opera (latest) -- Microsoft Edge (latest) +| [IE / Edge](http://godban.github.io/browsers-support-badges/)
IE / Edge | [Firefox](http://godban.github.io/browsers-support-badges/)
Firefox | [Chrome](http://godban.github.io/browsers-support-badges/)
Chrome | [Safari](http://godban.github.io/browsers-support-badges/)
Safari | [iOS Safari](http://godban.github.io/browsers-support-badges/)
iOS Safari | [Samsung](http://godban.github.io/browsers-support-badges/)
Samsung | [Opera](http://godban.github.io/browsers-support-badges/)
Opera | [Vivaldi](http://godban.github.io/browsers-support-badges/)
Vivaldi | [Electron](http://godban.github.io/browsers-support-badges/)
Electron | +| --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- | --------- | +| IE10, IE11, Edge| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions| last 2 versions -## Contributions +## How to Contribute -Contributions are always **welcome and recommended**! Here is how: +Contributions are always **welcome and recommended**! Here is how for beginner's: [Get started with open source click here](https://youtu.be/GbqSvJs-6W4) -- Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)). -- Clone to your machine +1. Contribution Requirements : + * When you contribute, you agree to give a non-exclusive license to AdminLTE.io to use that contribution in any context as we (AdminLTE.io) see appropriate. + * If you use content provided by another party, it must be appropriately licensed using an [open source](https://opensource.org/licenses) license. + * Contributions are only accepted through GitHub pull requests. + * Finally, contributed code must work in all supported browsers (see above for browser support). +2. Installation : + * Fork the repository ([here is the guide](https://help.github.com/articles/fork-a-repo/)). + * Clone to your machine ```bash git clone https://github.com/YOUR_USERNAME/AdminLTE.git ``` - -- Create a new branch -- Make your changes -- Create a pull request - -### Compile dist files - -To compile the dist files you need Node.js/npm, clone/download the repo then: - -1. `npm install` (install npm deps) -2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo) -3. `npm run production` (compile css/js files) + * Create a new branch +3. Compile dist files (Development) : + * To compile the dist files you need Node.js 10 or higher/npm (node package manager) + * Delete ./package-lock.json file + * `npm install` (install npm deps) + * `npm run dev` (developer mode, autocompile with browsersync support for live demo) + * Make your changes only in ./buid Folder OR package.json OR ./dist/js/demo.js OR in any html files which nessary to contribute + * Do not changes in ./dist/css/ AND ./dist/js/ Because its compiled files + * `npm run production` (compile css/js files and test every pages are perfectly working fine, before creating pull request) +4. Create a pull request ### Online one-click setup for contributing @@ -105,31 +108,19 @@ You can use Gitpod(an online IDE which is free for Open Source) for working on i [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/) -### Contribution Requirements: +### Compile dist files -- When you contribute, you agree to give a non-exclusive license to AdminLTE.io to use that contribution in any context as we (AdminLTE.io) see appropriate. -- If you use content provided by another party, it must be appropriately licensed using an [open source](https://opensource.org/licenses) license. -- Contributions are only accepted through GitHub pull requests. -- Finally, contributed code must work in all supported browsers (see above for browser support). +To compile the dist files you need Node.js/npm, clone/download the repo then: + +1. `npm install` (install npm deps) +2. _Optional:_ `npm run dev` (developer mode, autocompile with browsersync support for live demo) +3. `npm run production` (compile css/js files) ## License AdminLTE is an open source project by [AdminLTE.io](https://adminlte.io) that is licensed under [MIT](https://opensource.org/licenses/MIT). AdminLTE.io reserves the right to change the license of future releases. -## Latest Release - -- [AdminLTE 3](https://github.com/ColorlibHQ/AdminLTE/releases/latest) - -## Legacy Releases - -- [AdminLTE 2](https://github.com/ColorlibHQ/AdminLTE/releases/tag/v2.4.18) -- [AdminLTE 1](https://github.com/ColorlibHQ/AdminLTE/releases/tag/1.3.1) - -## Changelog - -Visit the [releases](https://github.com/ColorlibHQ/AdminLTE/releases) page to view the changelog - ## Image Credits - [Pixeden](http://www.pixeden.com/psd-web-elements/flat-responsive-showcase-psd)