Updated README.md files (added info about versioning) (#1490)

* Updated README.md files (added info about versioning)

* Typos
main
Boris Sekachev 6 years ago committed by GitHub
parent 9740ad78dd
commit 8df5d615a4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -4,6 +4,13 @@
The CVAT module written in TypeScript language. The CVAT module written in TypeScript language.
It presents a canvas to viewing, drawing and editing of annotations. It presents a canvas to viewing, drawing and editing of annotations.
## Versioning
If you make changes in this package, please do following:
- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
- After changing API (backward compatible new features) do: ``npm version minor``
- After changing API (changes that break backward compatibility) do: ``npm version major``
## Commands ## Commands
- Building of the module from sources in the ```dist``` directory: - Building of the module from sources in the ```dist``` directory:
@ -12,13 +19,6 @@ npm run build
npm run build -- --mode=development # without a minification npm run build -- --mode=development # without a minification
``` ```
- Updating of a module version:
```bash
npm version patch # updated after minor fixes
npm version minor # updated after major changes which don't affect API compatibility with previous versions
npm version major # updated after major changes which affect API compatibility with previous versions
```
## Using ## Using
Canvas itself handles: Canvas itself handles:

@ -4,6 +4,13 @@
This CVAT module is a clien-side JavaScipt library to management of objects, frames, logs, etc. This CVAT module is a clien-side JavaScipt library to management of objects, frames, logs, etc.
It contains the core logic of the Computer Vision Annotation Tool. It contains the core logic of the Computer Vision Annotation Tool.
## Versioning
If you make changes in this package, please do following:
- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
- After changing API (backward compatible new features) do: ``npm version minor``
- After changing API (changes that break backward compatibility) do: ``npm version major``
### Commands ### Commands
- Dependencies installation - Dependencies installation

@ -5,3 +5,10 @@ npm run build # build with minification
npm run build -- --mode=development # build without minification npm run build -- --mode=development # build without minification
npm run server # run debug server npm run server # run debug server
``` ```
## Versioning
If you make changes in this package, please do following:
- After not important changes (typos, backward compatible bug fixes, refactoring) do: ``npm version patch``
- After changing API (backward compatible new features) do: ``npm version minor``
- After changing API (changes that break backward compatibility) do: ``npm version major``

@ -0,0 +1,37 @@
# cvat-ui module
## Description
This is a client UI for Computer Vision Annotation Tool based on React, Redux and Antd
## Versioning
If you make changes in this package, please do following:
- After not important changes (typos, bug fixes, refactoring) do: ``npm version patch``
- After adding new features do: ``npm version minor``
- After significant UI redesign do: ``npm version major``
Important: If you have changed versions for ``cvat-core``, ``cvat-canvas``, ``cvat-data``,
you also need to do ``npm install`` to update ``package-lock.json``
## Commands
- Installing dependencies:
```bash
cd ../cvat-core && npm install && cd - && npm install
```
- Running development UI server with autorebuild on change
```bash
npm start
```
- Building the module from sources in the ```dist``` directory:
```bash
npm run build
npm run build -- --mode=development # without a minification
```
Important: You also have to run CVAT REST API server (please read ``CONTRIBUTING.md``)
to correct working since UI gets all necessary data (tasks, users, annotations) from there
Loading…
Cancel
Save