Skip to content

Commit 17bc88f

Browse files
committed
Updated readme
1 parent e5a8831 commit 17bc88f

1 file changed

Lines changed: 42 additions & 28 deletions

File tree

README.md

Lines changed: 42 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@ Full Featured Mobile HTML Framework For Building iOS & Android Apps
1010

1111
## Getting Started
1212
* [Getting Started Guide](https://framework7.io/docs/introduction.html)
13-
* Clone/download this repo
14-
* Start building your App from changing Kitchen Sink, or using a clean template.
1513

16-
## Build
14+
## Framework7 Development
1715

18-
Framework7 uses `gulp` and `rollup` to build a development (build) and productuin (dist) versions.
16+
Framework7 uses `gulp` and `rollup` to build a development (build) and production versions.
1917

2018
First you need to have `gulp-cli` which you should install globally.
2119

@@ -29,46 +27,61 @@ Then install all dependencies, in repo's root:
2927
$ npm install
3028
```
3129

32-
And build development version of Framework7:
33-
```
34-
$ npm run build:dev
35-
```
30+
## Development Builds
3631

37-
The result is available in `build/` folder.
32+
The following npm scripts are available to create development builds:
3833

39-
## Dist/Release
34+
* `build:dev` - build development versions of all packages (Core, Vue, React)
35+
* `build-core:dev` - build development version of Core (vanilla JS) Framework7
36+
* `build-react:dev` - build development version of Framework7 React package
37+
* `build-vue:dev` - build development version of Framework7 Vue package
4038

41-
To build production version of Framework7:
39+
Compiled results will be available in `build/` folder.
4240

43-
```
44-
$ npm run build:prod
45-
```
41+
## Production builds
4642

47-
Production version will be available in `dist/` folder.
43+
To build production versions the following npm scripts are available:
44+
45+
* `build:prod` - build prodiction versions of all packages (Core, Vue, React)
46+
* `build-core:prod` - build prodiction version of Core (vanilla JS) Framework7
47+
* `build-react:prod` - build prodiction version of Framework7 React package
48+
* `build-vue:prod` - build prodiction version of Framework7 Vue package
49+
50+
Compiled results will be available in `packages/` folder.
4851

4952
## Kitchen Sink
5053

51-
Kitchen Sink uses Ajax for navigation between pages so you will need a server.
54+
To Run Kitchen Sink with development environment (development version will be built first) use the following npm scripts:
5255

53-
Run Kitchen Sink with development environment (development version will be built first):
56+
* `dev` - build development versions of all packages (Core, Vue, React) and run local server. With this common script it will watch for changes in all `src/` files and rebuild all packages (Core, Vue, React)
57+
* `core:dev` - build development version of Core (vanilla JS) Framework7 package and run core Kitchen Sink
58+
* `react:dev` - build development version of Framework7 React package and run React Kitchen Sink
59+
* `vue:dev` - build development version of Framework7 Vue package and run Vue Kitchen Sink
5460

55-
```
56-
$ npm run dev
57-
```
61+
To Run Kitchen Sink with production builds (already compiled `/packages/` will be used), use the following npm scripts:
5862

59-
Run Kitchen Sink with production environment (configured to scripts and styles from `dist/` folder):
63+
* `prod` - build Kitchen Sinks with production versions
64+
* `core:prod` - run core Kitchen Sink with production Framework7 core package
65+
* `react:prod` - run React Kitchen Sink with production build of Framework7 React
66+
* `vue:prod` - run Vue Kitchen Sink with production build of Framework7 Vue
6067

61-
```
62-
$ npm run prod
63-
```
68+
## Source Code
69+
70+
Whole source code is locaed under `/src/` folder.
71+
72+
Framework7 uses Phenome compiler to generate React & Vue components. So all the React & Vue related code is under the `/src/phenome/` folder
73+
74+
Framework7 core library source code is under `/src/core/` folder
6475

6576
## Contributing
6677

6778
Before you open an issue please review the [contributing](https://github.com/framework7io/framework7/blob/master/CONTRIBUTING.md) guideline.
6879

69-
All changes should be commited to `src/` files. Framework7 uses LESS for CSS compliations, and ES modules JS files.
80+
**All changes should be commited to `src/` files only!**.
81+
82+
Framework7 uses LESS for CSS compliations, and ES modules JS files.
7083

71-
The project uses [.editorconfig](http://editorconfig.org/) to define the coding style of each file. We recommend that you install the Editor Config extension for your preferred IDE.
84+
The project uses [.editorconfig](http://editorconfig.org/) and [ESLint](https://eslint.org/) to define and lint the coding style of each file. We recommend that you install the Editor Config and ESLint extension for your preferred IDE.
7285

7386
If you want to help in Framework7 development and make it event better visit this page: http://framework7.io/contribute/
7487

@@ -88,6 +101,7 @@ Tutorials available at http://framework7.io/tutorials/
88101

89102
Appstore apps made with Framework7: http://framework7.io/showcase/
90103

91-
## v1
104+
## Previous Versions
92105

93-
Old v1 version of Framework7 is still available at [v1 branch](https://github.com/framework7io/Framework7/tree/v1)
106+
* [v2 branch](https://github.com/framework7io/Framework7/tree/v2)
107+
* [v1 branch](https://github.com/framework7io/Framework7/tree/v1)

0 commit comments

Comments
 (0)