add contributing instructions

master
Guillermo 8 years ago
parent 93e5b706b3
commit f5fc87638c
  1. 36
      README.md

@ -9,7 +9,7 @@ Tesseract.js is a pure javascript version of the Tesseract OCR Engine that can r
# Installation
Tesseract.js works with a `<script>` tag via local copy or cdn, or with `npm` (if you're using webpack / browserify).
## `<script/>`
## Script Tag
### CDN
@ -43,7 +43,35 @@ worker.recognize('#my-image')
```
## npm
## npm
###TODO
<!-- ```shell
> npm install tesseract-js ?
```-->
# Contributing
## Development
To run a development copy of tesseract.js, first clone this repo.
```shell
> git clone https://github.com/naptha/tesseract.js.git
```
Then, cd in to the folder, `npm install`, and `npm start`
```shell
npm install tesseract
```
> cd tesseract.js
> npm install && npm start
... a bunch of npm stuff ...
tesseract.js@1.0.0 start /Users/guillermo/Desktop/code_static/tesseract.js
node devServer.js
Listening at http://localhost:7355
```
Then open `http://localhost:7355` in your favorite browser. The devServer automatically rebuilds tesseract.js and tesseract.worker.js when you change files in the src folder.
## Building Static Files
After you've cloned the repo and run `npm install` as described in the [Development Section](#development), you can build static library files in the dist folder with
```shell
> npm run build
```

Loading…
Cancel
Save