Skip to content
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.

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

Some more README cleanups, and contribution guidelines #108

Merged
merged 2 commits into from May 8, 2019
Merged
Changes from 1 commit
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

@@ -3,6 +3,10 @@
We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.

Please file an issue before starting to code. This will give us a place to
collaborate on the design and direction. All non-trivial pull requests
(including those made by project members) require an associated issue.

## Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License
@@ -1,23 +1,27 @@
# Perception Toolkit
# Web Perception Toolkit

<p align="center">
<img alt="Perception Toolkit running on a phone" src="https://github.com/PolymerLabs/perception-toolkit/raw/master/assets/framed.jpg">
<img alt="Web Perception Toolkit running on a phone" src="https://github.com/PolymerLabs/perception-toolkit/raw/master/assets/framed.jpg">
</p>

This toolkit provides a set of components and utilities for developers to add an augmented experience to their website. For example, a primary use-case supported is the ability to detect barcodes (in -- say -- a real-world store) with the user's device camera, and to show them extended information on a given product.

Included in this toolkit is:
Please see our [Getting Started](https://perceptiontoolkit.dev/getting-started/) guide.

## Overview

Included in this toolkit:

* Device Support Detection
* Barcode Detector
* getUserMedia and environment camera
* Geolocation
* Wasm
* Detectors
* Barcode Detector (native / ZXing)
* QR Codes (native / ZXing)
* Barcode Detector (native / [ZXing](https://github.com/zxing))
* QR Codes (native / [ZXing](https://github.com/zxing))
* Geolocation (native)
* (TODO) Planar Image
* Planar Image

This comment has been minimized.

Copy link
@mmocny

mmocny May 8, 2019

Collaborator

2D Images, maybe?

The description for Augmented Images for ARCore is: "Augmented Images in ARCore lets you build AR apps that can respond to 2D images in the user's environment, such as posters or product packaging."

We don't augment the image, so I wouldn't call it Augmented Images.

This comment has been minimized.

Copy link
@smalls

smalls May 8, 2019

Author Collaborator

Split the difference: * 2D (Planar) Images?

We've been using the "planar image" terminology pretty consistently, and that's what the code is under in third_party, so I think there's value in keeping it - while, at the same time, I think being consistent with ARCore is important, and I think more folks might know what 2D is as opposed to planar.

This comment has been minimized.

Copy link
@smalls

smalls May 8, 2019

Author Collaborator

(I'll merge this but happy to revisit)

* (TODO) ML Image Classification
* UI
* Loader
@@ -30,15 +34,17 @@ Included in this toolkit is:

## Installation

We recommend installation via [npm](https://npmjs.com). Simply:
Please check out our [Getting Started](https://perceptiontoolkit.dev/getting-started/) guide for far more information.

Briefly, however: we recommend installation via [npm](https://npmjs.com). Simply:

```
npm install --save perception-toolkit
```

The intended use is detailed under `demo/`, where you can see how to set up barcode detection and the display of values to the end user. A good starting point is `demo/simple/index.html`, with a few small modifications to refer to `node_modules` (and assuming that `node_modules` is available at the root of your server, as it is with our sample server):
A few starting samples are under [demo](https://github.com/GoogleChromeLabs/perception-toolkit/tree/master/demo), where you can see how to set up barcode detection and the display of values to the end user. The most basic is [demo/simple](https://github.com/GoogleChromeLabs/perception-toolkit/tree/master/demo/simple), and this may be a good starting point in your own project. Once you copy [demo/simple/index.html](https://github.com/GoogleChromeLabs/perception-toolkit/blob/master/demo/simple/index.html) into your own project, you'll need a few small modifications to refer to the Web Perception Toolkit installed in `node_modules` (and assuming that `node_modules` is available at the root of your server, as it is with our sample server):

* You must specify `root` in `window.PerceptionToolkit.config`:
* You must specify `root` in the existing `window.PerceptionToolkit.config`:

```
window.PerceptionToolkit.config = {
@@ -48,8 +54,8 @@ The intended use is detailed under `demo/`, where you can see how to set up barc
}
```

* You must change the location of `bootstrap.js`, included at the end of
`index.html`:
* You must change the location of `bootstrap.js` (included at the end of
`<body>`):

```
<script src="/node_modules/perception-toolkit/lib/bundled/bootstrap.js"></script>
@@ -58,16 +64,14 @@ The intended use is detailed under `demo/`, where you can see how to set up barc

## Development

1. `git clone https://github.com/PolymerLabs/perception-toolkit`
We're glad you're excited and want to help out! Please read our [contributing](CONTRIBUTING.md) guide for hints.

1. `git clone https://github.com/GoogleChromeLabs/perception-toolkit`
1. `npm i`
1. `npm run build`
1. `npm run serve`
1. [Open the demo page at localhost:8080](http://localhost:8080)

## Building

`npm run build`

## Testing

`npm test`
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.