From 81bd64e8f59ad3f08be29672814310c5aef6cc8c Mon Sep 17 00:00:00 2001 From: Christopher Pietsch <cpietsch@gmail.com> Date: Tue, 2 Oct 2018 14:42:52 +0200 Subject: [PATCH] Update README.md --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ee75353..9f94f55 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ This repo contains the HTML, CSS and JS of the VIKUS Viewer software. To get sta ### Metadata -To use the VIKUS Viewer for a custom image collection, you need to prepare metadata files that describe the collection and objects, and configure the visualization. To get started, you first need to create a ```data``` folder which will contain all metadata and image files. Have a look at the metadata generated for the [Van Gogh collection](https://github.com/cpietsch/vikus-viewer-data/tree/master/vangogh) (Van Gogh Museum) as a reference for the following descriptions. +To use the VIKUS Viewer for a custom image collection, you need to prepare metadata files that describe the collection and objects, and configure the visualization. To get started, you first need to create a ```/data``` folder which will contain all metadata and image files. Have a look at the metadata generated for the [Van Gogh collection](https://github.com/cpietsch/vikus-viewer-data/tree/master/vangogh) (Van Gogh Museum) as a reference for the following descriptions. #### [config.json](https://github.com/cpietsch/vikus-viewer-data/blob/master/vangogh/config.json) @@ -40,10 +40,9 @@ The timeline.csv holds the information for the timeline displayed underneath the This is the information displayed on the left side when opening the visualization. You can put in any kind of [Markdown](https://marked.js.org/). -## Images - -Apart from the metadata, you need to preprocess the image files, i.e., to generate sprites and textures for the different zoom levels. Please see the [vikus-viewer-script](https://github.com/cpietsch/vikus-viewer-script) for the details. +### Images +Apart from the metadata, you need to preprocess the image files, i.e., to generate sprites and textures for the different zoom levels. Please see the [vikus-viewer-script](https://github.com/cpietsch/vikus-viewer-script) for the details. After running the script you can place the resulting folders into ```/data``` or any other location. Make sure that the texture URLs in the config.json point to these folders. ## Credits -- GitLab