Mercurial > hg > digilib

annotate README.md @ 1714:d497eb11141c default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
updated travis-ci config for automatic WAR releases.
author Robert Casties <casties@mpiwg-berlin.mpg.de>
date Mon, 18 Feb 2019 20:49:15 +0100
parents 439aefc7a6c9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1287
f4fb3482f116 authentication for annotator plugin works now.
robcast
parents: 1284
diff changeset
1 digilib - The Digital Image Library
1284
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
2 ===================================
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
3
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
4 A versatile image viewing environment for the internet.
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
5
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
6 ## What is digilib?
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
7
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
8 * `digilib` is a web based client/server technology for images. The image
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
9 content is processed on-the-fly by a Java Servlet on the server side so that
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
10 only the visible portion of the image is sent to the web browser on the client
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
11 side.
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
12 * `digilib` supports a wide range of image formats and viewing options on
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
13 the server side while only requiring an internet browser with Javascript and a
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
14 low bandwidth internet connection on the client side.
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
15 * `digilib` enables very detailed work on an image as required by
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
16 scholars with elaborate viewing features like an option to show images on the
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
17 screen in their original size.
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
18 * `digilib` facilitates cooperation of scholars over the internet and
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
19 novel uses of source material by image annotations and stable references that
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
20 can be embedded in URLs.
1443
e321607eb36e update lost license header and README.md.
robcast
parents: 1287
diff changeset
21 * `digilib` facilitates federation of image servers through a standards compliant
e321607eb36e update lost license header and README.md.
robcast
parents: 1287
diff changeset
22 [IIIF](http://iiif.io) image API.
1284
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
23 * `digilib` is Open Source Software under the Lesser General Public License,
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
24 jointly developed by the
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
25 [Max-Planck-Institute for the History of Science](http://www.mpiwg-berlin.mpg.de),
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
26 the [Bibliotheca Hertziana](http://www.biblhertz.it),
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
27 the [University of Bern](http://philoscience.unibe.ch) and others.
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
28
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
29 ## Where can I get digilib?
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
30
1654
22dd14eccdc0 Change digilib project links to GitHub.
Robert Casties <r0bcas7@gmail.com>
parents: 1443
diff changeset
31 * [Source code](https://github.com/robcast/digilib)
1656
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
32 * [Issue tracker](https://github.com/robcast/digilib/issues)
1705
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents: 1663
diff changeset
33 * [Docker images](https://hub.docker.com/r/robcast/digilib)
1284
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
34 * Daily built [WAR files](https://it-dev.mpiwg-berlin.mpg.de/downloads/digilib/daily-build/)
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
35 * Daily built [Javadoc](https://it-dev.mpiwg-berlin.mpg.de/downloads/digilib/daily-build/javadoc/)
39cdaa1ee33b README.md for github and more SourceForge links.
robcast
parents:
diff changeset
36 * [Maven repository](http://it-dev.mpiwg-berlin.mpg.de/maven-repo/)
1656
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
37
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1656
diff changeset
38 `digilib` documentation can be found on the
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1656
diff changeset
39 [digilib documentation pages](https://robcast.github.io/digilib/) on GitHub
1663
a243eb5cc480 More documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1658
diff changeset
40 or on [SourceForge](https://sourceforge.net/projects/digilib/).
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1656
diff changeset
41
1656
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
42 ## How do I run digilib?
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
43
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
44 Requirements:
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
45 * [git](https://git-scm.com/)
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1656
diff changeset
46 * [Java JDK](http://www.oracle.com/technetwork/java/javase/downloads/index.html) version 7 or later
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1656
diff changeset
47 * [Maven](https://maven.apache.org/) version 3 or later
1656
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
48
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
49 Build:
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
50 1. Clone the digilib repository
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
51
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
52 `git clone https://github.com/robcast/digilib.git`
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
53
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
54 2. Change to the repository
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
55
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
56 `cd digilib`
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
57
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
58 3. build and run the webapp in the embedded Jetty runtime for development
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
59
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1656
diff changeset
60 `mvn jetty:run-exploded --projects webapp`
1656
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
61
1705
439aefc7a6c9 README for Docker hub and configuration options for container.
Robert Casties <casties@mpiwg-berlin.mpg.de>
parents: 1663
diff changeset
62 and open http://localhost:8080/digilib/digilib.html in your browser.
1656
68f65786003e Add jetty plugin to pom.xml and "mvn jetty:run" to README.md
Robert Casties <r0bcas7@gmail.com>
parents: 1654
diff changeset
63
1658
28df291d4e26 Updated documentation.
Robert Casties <r0bcas7@gmail.com>
parents: 1656
diff changeset
64 or follow the build and install instructions on the [documentation pages](https://robcast.github.io/digilib/).