octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-06-17 11:22:20 +00:00
Code Issues Releases Activity

Update README for modified build

Browse Source
This commit is contained in:
Jia Hao 2016-01-23 14:04:52 +08:00
parent 264037a867
commit eabe6de892
1 changed files with 17 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -1,4 +1,5 @@
# Nativefier # Nativefier
[![npm version](https://badge.fury.io/js/nativefier.svg)](https://www.npmjs.com/package/nativefier)
![Dock Screenshot](https://raw.githubusercontent.com/jiahaog/nativefier/master/screenshots/Dock%20Screenshot.png) ![Dock Screenshot](https://raw.githubusercontent.com/jiahaog/nativefier/master/screenshots/Dock%20Screenshot.png)
@ -166,7 +167,7 @@ Height of the packaged application, defaults to `800px`.
Set the user agent to run the created app with. Set the user agent to run the created app with.
### [honest] #### [honest]
``` ```
--honest --honest
@ -181,26 +182,37 @@ A template app with the appropriate event listeners and callbacks set up is incl
## Development ## Development
Setting up the project
```bash ```bash
$ git clone https://github.com/jiahaog/nativefier.git $ git clone https://github.com/jiahaog/nativefier.git
$ cd nativefier $ cd nativefier
# Set up dev environment # Set up dependencies for the cli tool and the placeholder app
$ npm run dev-up $ npm run dev-up
# Sets up symlink for local files to global nativefier # Set up symlinks so that you can run `$ nativefier` for your local changes
$ npm link $ npm link
```
# You can then run nativefier with your test parameters After doing so, you can then run nativefier with your test parameters
```bash
$ nativefier <...> $ nativefier <...>
``` ```
After changing any source files, you need to run the following command to compile them. Don't forget to compile source files (after making changes):
```bash ```bash
$ npm run build $ npm run build
``` ```
Or you can automatically watch the files for changes with:
```bash
$ npm run watch
```
## Notes ## Notes
Tested mostly on OSX, but should work for windows and linux. Tested mostly on OSX, but should work for windows and linux.