Skip to content
This repository was archived by the owner on Dec 7, 2021. It is now read-only.

Commit 655d7b7

Browse files
authored
docs: updates to readme and changelog (#781)
Minor updates and corrections to the main readme and changelog.
1 parent 6ff2657 commit 655d7b7

File tree

2 files changed

+35
-27
lines changed

2 files changed

+35
-27
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<!-- cl-start -->
44

55
# [2.0.0](https://github.com/Microsoft/VoTT/compare/v2.0.0-preview.3...v2.0.0) (04-12-2019)
6-
[GitHub Release](https://github.com/Microsoft/VoTT/releases/tag/2.0.0)
6+
[GitHub Release](https://github.com/Microsoft/VoTT/releases/tag/v2.0.0)
77

88
- doc: update v1/master reference (#748)
99
- ci: update pipeline for v2 flipover to master (#747)
@@ -36,7 +36,7 @@
3636
- ci: update pipelines to work for all branches with prefix dev (#700)
3737

3838
# [2.0.0-preview.3](https://github.com/Microsoft/VoTT/compare/v2.0.0-preview.2...v2.0.0-preview.3) (03-20-2019)
39-
[GitHub Release](https://github.com/Microsoft/VoTT/releases/tag/2.0.0-preview.3)
39+
[GitHub Release](https://github.com/Microsoft/VoTT/releases/tag/v2.0.0-preview.3)
4040

4141
- ci: Clean up sonar cloud issues
4242
- Remove height from root style (#694)

README.md

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,34 +28,37 @@ VoTT helps facilitate an end-to-end machine learning pipeline:
2828

2929
<!-- toc -->
3030

31-
* [Getting Started](#getting-started)
32-
* [Download and install a release package for your platform (recommended)](#download-and-install-a-release-package-for-your-platform-recommended)
33-
* [Build and run from source](#build-and-run-from-source)
34-
* [V1 & V2](#v1--v2)
35-
* [Where is V1](#where-is-v1)
36-
* [V1 releases](#v1-releases)
37-
* [Can I use my V1 project in V2](#can-i-use-my-v1-project-in-v2)
38-
* [Using VoTT](#using-vott)
39-
* [Creating Connections](#creating-connections)
40-
* [Creating a New Project](#creating-a-new-project)
41-
* [Project Settings](#project-settings)
42-
* [Security Tokens](#security-tokens)
43-
* [Labeling an Image](#labeling-an-image)
44-
* [Labeling a Video](#labeling-a-video)
45-
* [Exporting Labels](#exporting-labels)
46-
* [Keyboard Shortcuts](#keyboard-shortcuts)
47-
* [Tag Shortcuts](#tag-shortcuts)
48-
* [Tag Ordering](#tag-ordering)
49-
* [Tag Locking](#tag-locking)
50-
* [Editor Shortcuts](#editor-shortcuts)
51-
* [Collaborators](#collaborators)
52-
* [Contributing to VoTT](#contributing-to-vott)
31+
- [VoTT (Visual Object Tagging Tool)](#vott-visual-object-tagging-tool)
32+
- [Table of Contents](#table-of-contents)
33+
- [Getting Started](#getting-started)
34+
- [Download and install a release package for your platform (recommended)](#download-and-install-a-release-package-for-your-platform-recommended)
35+
- [Build and run from source](#build-and-run-from-source)
36+
- [Run as Web Application](#run-as-web-application)
37+
- [V1 & V2](#v1--v2)
38+
- [Where is V1](#where-is-v1)
39+
- [V1 releases](#v1-releases)
40+
- [V1 projects in V2](#v1-projects-in-v2)
41+
- [Using VoTT](#using-vott)
42+
- [Creating Connections](#creating-connections)
43+
- [Creating a New Project](#creating-a-new-project)
44+
- [Project Settings](#project-settings)
45+
- [Security Tokens](#security-tokens)
46+
- [Labeling an Image](#labeling-an-image)
47+
- [Labeling a Video](#labeling-a-video)
48+
- [Exporting Labels](#exporting-labels)
49+
- [Keyboard Shortcuts](#keyboard-shortcuts)
50+
- [Tag Ordering](#tag-ordering)
51+
- [Tag Locking](#tag-locking)
52+
- [Editor Shortcuts](#editor-shortcuts)
53+
- [Mouse Controls](#mouse-controls)
54+
- [Collaborators](#collaborators)
55+
- [Contributing to VoTT](#contributing-to-vott)
5356

5457
<!-- tocstop -->
5558

5659
## Getting Started
5760

58-
VoTT can be installed as a native application or run from source.
61+
VoTT can be installed as a native application or run from source. VoTT is also available as a [stand-alone Web application](https://vott.z5.web.core.windows.net) and can be used in any modern Web browser.
5962

6063
### Download and install a release package for your platform (recommended)
6164

@@ -71,11 +74,16 @@ VoTT requires [NodeJS (>= 10.x, Dubnium) and NPM](https://github.com/nodejs/Rele
7174
npm ci
7275
npm start
7376
```
74-
7577
> **IMPORTANT**
7678
>
7779
> When running locally with `npm`, both the electron and the browser versions of the application will start. One major difference is that the electron version can access the local file system.
7880
81+
### Run as Web Application
82+
83+
Using a modern Web browser, VoTT can be loaded from: [https://vott.z5.web.core.windows.net](https://vott.z5.web.core.windows.net)
84+
85+
As noted above, the Web version of VoTT *cannot* access the local file system; all assets must be imported/exported through a Cloud project.
86+
7987
## V1 & V2
8088

8189
VoTT V2 is a refactor and refresh of the original Electron-based application. As the usage and demand for VoTT grew, `V2` was started as an initiative to improve and make VoTT more extensible and maintainable. In addition, `V2` uses more modern development frameworks and patterns (React, Redux) and is authored in TypeScript.
@@ -238,7 +246,7 @@ VOTT allows you to fine tune the bounding boxes using the arrow keys in a few di
238246
* Ctrl + Alt + Arrowkey - Shrink Region
239247
* Ctrl + Shift + Arrowkey - Expand Region
240248

241-
The slide viewer can be navigated from the keyboard as follows:
249+
The slide viewer can be navigated from the keyboard as follows:
242250

243251
* W or ArrowUp - Previous Asset
244252
* S or ArrowDown - Next Asset

0 commit comments

Comments
 (0)