Skip to content

Commit 71a8348

Browse files
committedAug 30, 2020
Move all source files to src/
1 parent 5b8366b commit 71a8348

File tree

7 files changed

+15
-13
lines changed

7 files changed

+15
-13
lines changed
 

‎README.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -153,12 +153,11 @@ html5QrCode.start(
153153
});
154154
```
155155

156-
> You can optionally set another argument in constructor called `verbose`
157-
> to print all logs to console
158-
>
159-
> ```js
160-
> const html5QrCode = new Html5Qrcode("reader", /* verbose= */ true);
161-
> ```
156+
> You can optionally set another argument in constructor called `verbose` to print all logs to console
157+
158+
```js
159+
const html5QrCode = new Html5Qrcode("reader", /* verbose= */ true);
160+
```
162161

163162
In mobile devices you may want users to directly scan the QR code using the back camera or the front camera for some use cases. For such cases you can avoid using the exact camera device id that you get from `Html5Qrcode.getCameras()`. The `start()` method allows passing constraints in place of camera device id similar to [html5 web API syntax](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices/getUserMedia#Syntax). You can start scanning like mentioned in these examples:
164163

@@ -465,8 +464,8 @@ Here's an example of normal and mirrored QR Code
465464

466465
## How to modify and build
467466
1. Code changes should only be made to
468-
- [html5-qrcode.js](./html5-qrcode.js)
469-
- [html5-qrcode-scanner.js](./html5-qrcode-scanner.js)
467+
- [src/html5-qrcode.js](./src/html5-qrcode.js)
468+
- [src/html5-qrcode-scanner.js](./src/html5-qrcode-scanner.js)
470469
- [third_party/qrcode.js](./third_party/qrcode.js)
471470
2. Run `npm run-script build`.
472471
> This should do `transpiling` --> `minification` --> `merging` different js code.
@@ -475,7 +474,7 @@ Here's an example of normal and mirrored QR Code
475474
- Run the tests before sending PR, all tests should run.
476475
- Please add tests for new behaviors sent in PR.
477476

478-
> Before sending a pull request with changes to [html5-qrcode.js](./html5-qrcode.js) please run instruction (2).
477+
> Before sending a pull request with changes to [src](./src) please run instruction (2).
479478
480479
## Credits
481480
The decoder used for the QRcode reading is from `LazarSoft` https://github.com/LazarSoft/jsqrcode<br>

‎compatibility.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Compatibility list for tested device
22

3+
**THIS IS WORK IN PROGRESS**: If you have tested the library to work with a different device please
4+
send a pull request.
5+
36
## Android
47
| Device | Android OS | Browser | Inline scanning | File Scanning | Known issues |
58
| --- | --- | --- | --- | --- | --- |

‎minified/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Generated code, do not modify manually.
22

3-
- All files in this directory are minified from source code in the project.
3+
- All files in this directory are minified from source code in the project hosted at [src](../src).
44
- Generated files should be supported in all major browsers.

‎scripts/build.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ echo 'Initiating build sequence'
77
## find assets/*.* -print0| xargs -0 -i{} bash -c 'echo s%{}%data\\:\\;base64\\,$(base64 -w0 {})%g'|sed -i -f - html5-qrcode.js
88

99
## Transpile the Main Js Code
10-
babel html5-qrcode.js -d transpiled
10+
babel src/html5-qrcode.js -d transpiled
1111
echo 'html5-qrcode.js transpiled'
1212

13-
babel html5-qrcode-scanner.js -d transpiled
13+
babel src/html5-qrcode-scanner.js -d transpiled
1414
echo 'html5-qrcode-scanner.js transpiled'
1515

1616
## Minify the code
File renamed without changes.
File renamed without changes.

‎transpiled/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Generated code, do not modify manually.
22

3-
- All files in this directory are transpiled from their source files in the project root.
3+
- All files in this directory are transpiled from their source files in [src](../src).
44
- The files are created using [babeljs.io](https://babeljs.io).
55
- Generated files should be supported in all major browsers.

0 commit comments

Comments
 (0)
Please sign in to comment.