Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
sahirgomez1 committed Jul 7, 2021
1 parent 5ee1e75 commit 0fd8115
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# YCB Object 3d annotation
# YCB Object 3D annotation

UI to annotate videos using 3d objects, in a camera-object scene.
TO DO: Multi camera synchronization and model-in-the-loop.
UI to annotate videos using 3d objects, in a camera-object scene.\
TO DO (WIP): Multi camera synchronization and model-in-the-loop.

## Installation and running

Expand All @@ -16,14 +16,14 @@ In the project directory, install all dependencies with.
```
$ npm install
```
Then run to start the development server.
To start the development server. Run
```
$ npm start
```
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

Currently, there are 4 different objects in the public folder for testing. Add your 3D objects to the public folder, use `.gltf` files. We suggest an [OBJ coverter](https://github.com/CesiumGS/obj2gltf), then optimize
your glTF assets with `gltf-pipeline`, [more info](https://www.npmjs.com/package/gltf-pipeline).\
your glTF assets with `gltf-pipeline`, [more info](https://www.npmjs.com/package/gltf-pipeline).

[See demo](https://op3u5.csb.app/)

Expand Down

0 comments on commit 0fd8115

Please sign in to comment.