Skip to content

Commit

Permalink
fixed docs emojis (#90)
Browse files Browse the repository at this point in the history
* changed readme to show the emojis right and made index link to readme

* changed urls to work on docs
  • Loading branch information
jiribuchta authored Nov 21, 2024
1 parent 9aeb714 commit 6af1e92
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 119 deletions.
41 changes: 18 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,33 +14,28 @@ and bring it to something that covers all your needs. With the focus on flexibil
viewer tries to address issues in digital pathology related to AI adoption.

### Behaves as an enhanced OpenSeadragon*, a popular (feature-less) flexible viewer.
<ul>
:floppy_disk: Full data & API protocol flexibility. No backend services are hardcoded.<br>
:bar_chart: Powerful visualization capabilities, similar to Photoshop layers.<br>
:gear: Configurability: static & runtime.<br>
:package: Annotations, and other plugins introduce an unusual set of additional features
that take the WSI far beyond standard.
</ul>
:floppy_disk: Full data & API protocol flexibility. No backend services are hardcoded.
:bar_chart: Powerful visualization capabilities, similar to Photoshop layers.
:gear: Configurability: static & runtime.
:package: Annotations, and other plugins introduce an unusual set of additional features that take the WSI far beyond standard.

### Powerful set of modules and plugins: Advanced extensibility & Existing features
<ul>
:key: OIDC Authentication<br>
:book: Visualization Storytelling<br>
:memo: Versatile annotations and support for multiple annotation formats.<br>
:bulb: Flexible tutorial system: send viewer session with custom tutorials!<br>
:keyboard: Action shortcuts (screenshot, copy of viewport location...)<br>
...<br>
:fast_forward: And more including custom functionality!<br>
</ul>
:key: OIDC Authentication
:book: Visualization Storytelling
:memo: Versatile annotations and supported annotation formats.
:bulb: Flexible tutorial system: send viewer session with custom tutorials!
:bookmark_tabs: EMPAIA Integration
:keyboard: Action shortcuts (screenshot, copy of viewport location...)
...
:fast_forward: And more including custom functionality!

### Servers
To parse existing modules, plugins, read POST data the viewer uses a server. Don't worry,
we try to cover it all!
<ul>
:heavy_check_mark: PHP Server<br>
:heavy_check_mark: Node.js Server<br>
:heavy_check_mark: Server-less: compiled once, used statically!<br>
</ul>

:white_check_mark: PHP Server
:white_check_mark: Node.js Server
:white_check_mark: Server-less: compiled once, used statically!


## :point_right: What IS NOT xOpat?
Expand All @@ -51,7 +46,7 @@ AI jobs can either add their data to xOpat via raster images (just like WSI serv
to the Annotations plugin. Add your custom plugins to connect to services of your choice & do whatever you need!

## Documentation
Please, visit https://xopat.readthedocs.io/.
Please, visit <https://xopat.readthedocs.io/>.

## API
Please, see https://rationai.github.io/xopat/.
Please, see <https://rationai.github.io/xopat/>.
96 changes: 0 additions & 96 deletions index.md

This file was deleted.

1 change: 1 addition & 0 deletions index.md

0 comments on commit 6af1e92

Please sign in to comment.