Skip to content

Fix mistake in readme. #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bzgrey wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix mistake in readme. #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

## Installation
```
git clone https://github.com/alisaono/nbdemo.git
cd nbdemo
git clone https://github.com/haystack/nbclient.git
cd nbclient
npm install
npm install -g webpack
```
Expand All @@ -17,7 +17,7 @@ npm install -g webpack
- Exception is the CSS files which are under `public/style`
- To compile the JS/Vue source code:
```
cd nbdemo
cd nbclient
webpack
```
- You'll find the compiled code (`bundle.js`) under `public/js`
Expand All @@ -27,7 +27,7 @@ webpack
### Hosting files locally
You can host the plugin files locally, which is useful for embedding and testing them locally. To do so:
```
cd nbdemo
cd nbclient
npm run start
```
You will then find the files hosted at `localhost:3001` (e.g. `localhost:3001/js/bundle.js`)
Expand All @@ -37,7 +37,7 @@ Note: Since we're using a self generated certificate for development, the browse
### Code documentation
To see a nice webpage version of the in-file code documentation as, do:
```
cd nbdemo
cd nbclient
./node_modules/.bin/jsdoc -r src/ -c jsdoc.json
```
You will then find `out/index.html` which you can view in your browser.
Expand Down