Skip to content

Commit 9596edc

Browse files
committed
Update README.md
1 parent 3ea97bc commit 9596edc

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ AngularJS, Angular2, React and Meteor versions are coming soon.
3333
### Table of contents
3434

3535
* [Browser support](#browser-support)
36-
* [Getting started](#getting-started)
36+
* [Download](#download)
37+
* [Development](#development)
3738
* [Folder structure](#folder-structure)
3839
* [File types](#file-types)
3940
* [Build tasks](#build-tasks)
@@ -51,13 +52,17 @@ AngularJS, Angular2, React and Meteor versions are coming soon.
5152
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).
5253

5354
<br>
54-
## Getting Started
55+
## Download
5556

56-
For assembling the application, you need to have [NodeJs](https://nodejs.org/en/) with npm. You also need to have Bower installed globally.
57+
You can download this project in 2 different ways: <a href="https://github.com/modularcode/modular-admin-html/releases/download/v1.0.0-beta/modular-admin-html-v1.0.0-beta.zip" target="_blank">download zip</a> or ```git clone https://github.com/modularcode/modular-admin-html.git ```.
5758

58-
```
59-
npm install -g bower
60-
```
59+
#### [Download ZIP](https://github.com/modularcode/modular-admin-html/releases/download/v1.0.0-beta/modular-admin-html-v1.0.0-beta.zip)
60+
61+
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).
62+
63+
**Warning!** all changes made in ```dist/``` folder would be overwriten on application build.
64+
65+
#### Git clone
6166

6267
Clone repository to the local `modular-admin-html` folder
6368
```
@@ -69,6 +74,18 @@ Change to the new folder
6974
cd modular-admin-html
7075
```
7176

77+
The cloned repository desn't contain prebuilt version of the project and you need to build it, See [development](#development).
78+
79+
## Development
80+
81+
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.
82+
From the project folder run the following commands:
83+
84+
Install bower globally
85+
```
86+
npm install -g bower
87+
```
88+
7289
Install npm dependencies
7390
```
7491
npm install

0 commit comments

Comments
 (0)