Skip to content

Commit d5786a0

Browse files
committed
Readme update
1 parent d440bd2 commit d5786a0

File tree

1 file changed

+19
-53
lines changed

1 file changed

+19
-53
lines changed

README.md

Lines changed: 19 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -8,79 +8,40 @@
88

99
<p align="center">
1010
<strong>
11-
<a href="http://modularcode.github.io/modular-admin-html/" target="_blank">View Demo</a> | <a href="https://github.com/modularcode/modular-admin-html/releases/download/v1.2.0/modular-admin-html-1.2.0.zip" target="_blank">Download ZIP</a>
11+
<a href="http://modularcode.github.io/modular-admin-html/" target="_blank">View Demo</a> | <a href="https://github.com/modularcode/modular-admin-html/releases" target="_blank">Download ZIP</a>
1212
</strong>
1313
</p>
1414

1515
[ModularAdmin](http://modularcode.github.io/modular-admin-html/) is an open source dashboard theme built in a modular way. That makes it extremely easy to scale, modify and maintain.
1616

1717

18+
## Getting Started
1819

19-
## Download
20+
### 1. Download
2021

21-
You can download this project in 2 different ways: <a href="https://github.com/modularcode/modular-admin-html/releases/download/v1.2.0/modular-admin-html-1.2.0.zip" target="_blank">download zip</a> or ```git clone https://github.com/modularcode/modular-admin-html.git ```.
22+
You can download this project in 2 different ways: <a href="https://github.com/modularcode/modular-admin-html/releases" target="_blank">download zip</a> or ```git clone https://github.com/modularcode/modular-admin-html.git ```.
2223

23-
#### [Download ZIP](https://github.com/modularcode/modular-admin-html/releases/download/v1.2.0/modular-admin-html-1.2.0.zip)
24+
#### [Download ZIP](https://github.com/modularcode/modular-admin-html/releases)
2425

25-
The downloaded zip file will contain ```dist/``` folder which is compiled version of the project (with all scripts are merged together, processed styles and templates). You can use it as final result, but for development you should use aplication sources locaed in ```src/``` folder and rebuild the project. See [development](#development).
26-
27-
**Warning!** all changes made in ```dist/``` folder would be overwriten on application build.
2826

2927
#### Git clone
3028

3129
Clone repository to the local `modular-admin-html` folder
3230
```
3331
git clone https://github.com/modularcode/modular-admin-html.git
34-
```
35-
36-
The cloned repository desn't contain prebuilt version of the project and you need to build it, See [development](#development).
37-
38-
## Other versions
39-
40-
This is the HTML version, which is great for enhancing and integrating it into other platforms and environments.
41-
AngularJS, Angular2, React and Meteor versions are coming soon.
42-
43-
### Table of contents
44-
45-
* [Browser support](#browser-support)
46-
* [Development](#development)
47-
* [Docker](#docker)
48-
* [Folder structure](#folder-structure)
49-
* [File types](#file-types)
50-
* [Build tasks](#build-tasks)
51-
* [Get in touch](#get-in-touch)
52-
53-
-------
54-
55-
## Browser support
56-
57-
* Last 2 Versions FF, Chrome, IE 10+, Safari Mac
58-
* IE 10+
59-
* Android 4.4+, Chrome for Android 44+
60-
* iOS Safari 7+
61-
62-
Some of the components use the new Flexbox Layout module which is available in most modern browsers. Bootstrap4 is used as main framework. Please make sure that it's suitable for you: [Flexbox browser support](http://caniuse.com/#feat=flexbox).
63-
64-
<br>
65-
6632
67-
## Development
68-
69-
For building the application, you need to have [NodeJs](https://nodejs.org/en/) with npm. You also need to have [Bower](http://bower.io/) installed globally.
33+
```
34+
### 2. Build the project
7035

71-
After [downloading](#download) run the following commands from the project folder:
36+
The cloned/downloaded repository desn't contain prebuilt version of the project and you need to build it. You need to have [NodeJs](https://nodejs.org/en/) with npm. You also need to have [Bower](http://bower.io/) installed globally.
7237

73-
Install bower globally
74-
```
75-
npm install -g bower
76-
```
7738

7839
Install npm dependencies
7940
```
8041
npm install
8142
```
8243

83-
Install front-end bower dependencies
44+
Install bower dependencies
8445
```
8546
bower install
8647
```
@@ -92,7 +53,14 @@ npm start
9253

9354
Open the project [http://localhost:4000](http://localhost:4000).
9455

95-
> The project is built by Gulp. You can read more info in [Build Tasks](#build-tasks) section
56+
> The project is built by Gulp.
57+
58+
59+
**Warning!** all changes made in ```dist/``` folder would be overwriten on application build.
60+
61+
62+
-------
63+
9664

9765
## Running in Docker
9866

@@ -109,6 +77,8 @@ Launch the container
10977
docker-compose up
11078
```
11179

80+
-------
81+
11282
<br>
11383

11484
## Folder Structure
@@ -279,10 +249,6 @@ In addition to application files, there are also third party plugin files (e.g.
279249

280250
<br>
281251

282-
## Build Tasks
283-
284-
<br>
285-
286252
## Get in touch
287253

288254
You can get in touch with us in gitter chat [![Join the chat at https://gitter.im/modularcode/modular-admin](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/modularcode/modular-admin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or in the [ModularCode Facebook Group](https://www.facebook.com/groups/710770032358423/).

0 commit comments

Comments
 (0)