Skip to content

Commit

Permalink
Add build badge, dev instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
danvk authored Dec 8, 2017
1 parent 278c485 commit cd141d3
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[![CircleCI](https://circleci.com/gh/danvk/localturk.svg?style=svg)](https://circleci.com/gh/danvk/localturk)

localturk
=========

Expand All @@ -21,7 +23,7 @@ Install:
Run:

cd localturk/sample
localturk --static_dir . transcribe.html tasks.csv outputs.csv
localturk transcribe.html tasks.csv outputs.csv

Then visit http://localhost:4321/ to start Turking.

Expand Down Expand Up @@ -66,10 +68,30 @@ The use case described above (classifying images) is an extremely common one.
To expedite this, localturk provides a separate script for doing image
classification. The example above could be written as:


classify-images --labels 'Has a red ball,Does not have a red ball' *.png

This will bring up a web server with a UI for assigning one of those two labels
to each image on your local file system. The results will go in `output.csv`.

For more details, run `classify-images --help`.

Development
-----------

To make changes to localturk, clone it and set it up using `yarn`:

yarn

You can run `localturk.ts` or `classify-images.ts` directly using `ts-node`:

ts-node localturk.ts path/to/template.html path/to/tasks.csv path/to/output.csv

To type check and run the tests:

yarn tsc
yarn test

To publish a new version on npm, run:

yarn tsc
yarn publish

0 comments on commit cd141d3

Please sign in to comment.