diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 2b46ecbf6..008e4375d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -57,3 +57,21 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} with: asset_paths: '["./client/dist_electron/DIVE-Desktop*"]' + + docs: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + with: + # "ref" specifies the branch to check out. + # "github.event.release.target_commitish" is a global variable and specifies the branch the release targeted + ref: ${{ github.event.release.target_commitish }} + + # Deploy docs + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CONFIG_FILE: mkdocs.yml + EXTRA_PACKAGES: build-base diff --git a/docs/Dive-Desktop.md b/docs/Dive-Desktop.md index 1c39fae69..21635d071 100644 --- a/docs/Dive-Desktop.md +++ b/docs/Dive-Desktop.md @@ -6,7 +6,18 @@ DIVE Desktop has most of the same UI and features as VIAME Web **without** requi ## Installation -[Download and install the package for your OS from GitHub](https://github.com/VIAME/VIAME-Web/releases) +**[⬇️ Download the latest DIVE Desktop from GitHub.](https://github.com/VIAME/VIAME-Web/releases/latest)** + +Choose an **asset** from the list matching your operating system: + +| OS | Extension | Description | +| -------- | --------- | ----------- | +| Windows | .exe | Portable executable (recommended) | +| Windows | .msi | Installer file | +| MacOS | .dmg | MacOS DiskImage (Intel only, M1 not supported) | +| Linux | .AppImage | Portable executable for all Linux platforms (recommended) | +| Linux | .snap | Ubuntu SnapCraft package | + ## Features diff --git a/docs/index.md b/docs/index.md index 33a97c431..ecdb00e7c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,20 +2,12 @@ This is the documentation for DIVE, an open-source annotation system that integrates with VIAME. -## Definitions - -* **DIVE** is the annotator and data management software system. It is our name for the code and capabilities, including both web and desktop, that can be deployed and configured for a variety of needs. It integrates tightly with VIAME, but is separate from that tool suite. - * The desktop and girder (web) systems are known as **DIVE Desktop** and **DIVE Web**. -* **VIAME** stands for "Video and Image Analytics for Marine Environments". It is a suite of computer vision tools for object detection, tracking, rapid model generation, and many other types of analysis. Get more info at [viametoolkit.org](https://www.viametoolkit.org/) -* **VIAME Web** is the *specific* DIVE Web deployment at [viame.kitware.com](https://viame.kitware.com). It includes a web-based annotator with the capabilities to run VIAME workflows on user-provided data. You may deploy the web system into your own labratory or cloud environment. +![Home](images/Banner.png) -## Need help? +## Get Help * For problems, feature requests, etc. contact us through our [discussion board](https://github.com/VIAME/VIAME/discussions). This board is for all topics related to VIAME or DIVE. * You can also email `viame-web@kitware.com` - -![Home](images/Banner.png) - ## VIAME Web (Browser) Version VIAME Web is available at [viame.kitware.com](https://viame.kitware.com). @@ -41,3 +33,10 @@ Current capabilities of DIVE include: * Automatic object detection and tracking of user-imported data. * Manual user refinement of automatically generated tracks * Export of generated annotations. + +## Definitions + +* **DIVE** is the annotator and data management software system. It is our name for the code and capabilities, including both web and desktop, that can be deployed and configured for a variety of needs. It integrates tightly with VIAME, but is separate from that tool suite. + * The desktop and girder (web) systems are known as **DIVE Desktop** and **DIVE Web**. +* **VIAME** stands for "Video and Image Analytics for Marine Environments". It is a suite of computer vision tools for object detection, tracking, rapid model generation, and many other types of analysis. Get more info at [viametoolkit.org](https://www.viametoolkit.org/) +* **VIAME Web** is the *specific* DIVE Web deployment at [viame.kitware.com](https://viame.kitware.com). It includes a web-based annotator with the capabilities to run VIAME workflows on user-provided data. You may deploy the web system into your own labratory or cloud environment.