Remove `$` from docs

This allows shell commands to be copy and pasted easily
This commit is contained in:
Jia Hao Goh 2017-04-09 10:36:27 +08:00
parent 1658db53a6
commit 36e34c95a5
3 changed files with 20 additions and 21 deletions

View File

@ -10,7 +10,7 @@
You want to make a native wrapper for WhatsApp Web (or any web page).
```bash
$ nativefier web.whatsapp.com
nativefier web.whatsapp.com
```
![Walkthrough](screenshots/walkthrough.gif)
@ -51,8 +51,7 @@ View the changelog [here](https://github.com/jiahaog/nativefier/blob/development
- [Node.js](https://nodejs.org/) `>=4`
```bash
# for use from the command line
$ npm install nativefier -g
npm install nativefier -g
```
See [optional dependencies](#optional-dependencies) for more.
@ -62,13 +61,13 @@ See [optional dependencies](#optional-dependencies) for more.
Creating a native desktop app for [medium.com](http://medium.com):
```bash
$ nativefier "http://medium.com"
nativefier "http://medium.com"
```
Nativefier will intelligently attempt to determine the app name, your OS and processor architecture, among other options. If desired, the app name or other options can be overwritten by specifying the `--name "Medium"` as part of the command line options, as such.
```bash
$ nativefier --name "Some Awesome App" "http://medium.com"
nativefier --name "Some Awesome App" "http://medium.com"
```
Read the [API documentation](docs/api.md) for other command line flags and options that can be used to configure the packaged app.

View File

@ -42,7 +42,7 @@
## Command Line
```bash
$ nativefier [options] <targetUrl> [dest]
nativefier [options] <targetUrl> [dest]
```
Command line options are listed below.
@ -275,7 +275,7 @@ Allows you to inject a javascript or css file. This command can be run multiple
Example:
```bash
$ nativefier http://google.com --inject ./some-js-injection.js --inject ./some-css-injection.css ~/Desktop
nativefier http://google.com --inject ./some-js-injection.js --inject ./some-css-injection.css ~/Desktop
```
#### [full-screen]
@ -340,7 +340,7 @@ Enables crash reporting and set the URL to submit crash reports to
Example:
```bash
$ nativefier http://google.com --crash-reporter https://electron-crash-reporter.appspot.com/PROJECT_ID/create/
nativefier http://google.com --crash-reporter https://electron-crash-reporter.appspot.com/PROJECT_ID/create/
```
#### [zoom]
@ -357,7 +357,7 @@ You can use the Nativefier programmatic API as well.
```bash
# install and save to package.json
$ npm install --save nativefier
npm install --save nativefier
```
In your `.js` file:

View File

@ -5,48 +5,48 @@
First clone the project
```bash
$ git clone https://github.com/jiahaog/nativefier.git
$ cd nativefier
git clone https://github.com/jiahaog/nativefier.git
cd nativefier
```
Install dependencies
```bash
# OSX and Linux
$ npm run dev-up
npm run dev-up
# Windows
$ npm install
$ cd app
$ npm install
npm install
cd app
npm install
```
Don't forget to compile source files:
```bash
$ npm run build
npm run build
```
You can set up symlinks so that you can run `$ nativefier` for your local changes
You can set up symlinks so that you can run `nativefier` for your local changes
```bash
$ npm link
npm link
```
After doing so, you can then run Nativefier with your test parameters
```bash
$ nativefier <...>
nativefier <...>
```
Or you can automatically watch the files for changes with:
```bash
$ npm run watch
npm run watch
```
## Tests
```bash
$ npm test
npm test
```