Skip to content

Commit 04127ff

Browse files
authored
[Developer:Documentation] Update README.md for Github releasing (#671)
1 parent c0952a3 commit 04127ff

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

+13-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ To report issues for pdf-annotate.js, please file them under the [Submitty/Submi
1919
## Installation
2020

2121
```bash
22-
npm install @submitty/pdf-annotate.js
22+
npm install Submitty/pdf-annotate.js
2323
```
2424

2525
## Example
@@ -73,3 +73,15 @@ $ npm test
7373
# lint the code
7474
$ npm run lint
7575
```
76+
77+
## Building
78+
**Do not** commit your built files when contributing.
79+
If on Windows, change the `build` script in `package.json` to `webpack && SET MINIFY=1&webpack`.
80+
```bash
81+
# switch to node v14 or earlier
82+
$ nvm use 14
83+
84+
# build the dist files
85+
$ npm run build
86+
```
87+

0 commit comments

Comments
 (0)