Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 6a4857f

Browse files
committedJul 12, 2024
Merge branch 'bump_webpack' of github.com:thepiyush-303/pdf-annotate.js into bump_webpack
2 parents dfe5fbc + 2313051 commit 6a4857f

File tree

5 files changed

+17
-5
lines changed

5 files changed

+17
-5
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+

‎dist/pdf-annotate.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/pdf-annotate.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/pdf-annotate.min.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎dist/pdf-annotate.min.js.map

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
Please sign in to comment.