Skip to content

Commit

Permalink
[DOCUMENTATION] Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastian-meyer committed May 30, 2024
1 parent 244d382 commit 5bd3ff6
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@

Kitodo.Presentation is a feature-rich framework for building a METS- or IIIF-based digital library. It is part of the Kitodo Digital Library Suite.

Kitodo.Presentation is highly customizable through a user-friendly backend and flexible design templates. Since it is based on the great free and open source Content Management System [TYPO3](https://typo3.org), it integrates perfectly with your website and can easily be managed by editors. Kitodo.Presentation provides a comprehensive toolset covering all requirements for presenting digitized media. It implements international standards such as [IIIF Image API](https://iiif.io/api/image), [IIIF Presentation API](https://iiif.io/api/presentation), [OAI Protocol for Metadata Harvesting](http://www.openarchives.org/OAI/openarchivesprotocol.html), [METS](http://www.loc.gov/standards/mets), [MODS](http://www.loc.gov/standards/mods), [TEI](http://www.tei-c.org), [ALTO](http://www.loc.gov/standards/alto), and can be configured to support any other descriptive XML format using simple XPath expressions. With Kitodo.Presentation you can publish digitized books, manuscripts, periodicals, newspapers, archival materials, audio and video.
Kitodo.Presentation is highly customizable through a user-friendly backend and flexible design templates. Since it is based on the great free and open source Content Management System [TYPO3](https://typo3.org), it integrates perfectly with your website and can easily be managed by editors. Kitodo.Presentation provides a comprehensive toolset covering all requirements for presenting digitized media. It implements international standards such as [IIIF Image API](https://iiif.io/api/image), [IIIF Presentation API](https://iiif.io/api/presentation), [OAI Protocol for Metadata Harvesting](https://www.openarchives.org/OAI/openarchivesprotocol.html), [METS](https://www.loc.gov/standards/mets), [MODS](https://www.loc.gov/standards/mods), [TEI](https://www.tei-c.org), [ALTO](https://www.loc.gov/standards/alto), and can be configured to support any other descriptive XML format using simple XPath expressions. With Kitodo.Presentation you can publish digitized books, manuscripts, periodicals, newspapers, archival materials, 3D objects, audio and video.

For a complete overview of all features, visit the [Kitodo homepage](https://www.kitodo.org/software/kitodopresentation/features).

[![Codacy Grade](https://api.codacy.com/project/badge/Grade/b2a7bd8e42ef405d95ca503e4fe95320)](https://app.codacy.com/gh/kitodo/kitodo-presentation)

Kitodo was formerly known as Goobi. Older releases can be found on [Launchpad](https://launchpad.net/goobi-presentation).
*Kitodo was formerly known as Goobi. Older releases can be found on [Launchpad](https://launchpad.net/goobi-presentation).*

## Requirements

Kitodo.Presentation requires [TYPO3](https://get.typo3.org) with [PHP](https://secure.php.net). It uses [MySQL](https://www.mysql.com) or [MariaDB](https://mariadb.com) as database and [Apache Solr](https://lucene.apache.org/solr) via [Solarium](http://www.solarium-project.org/) as search engine backend.
Kitodo.Presentation requires [TYPO3](https://get.typo3.org) with [PHP](https://www.php.net). It uses [MySQL](https://www.mysql.com) or [MariaDB](https://mariadb.com) as database and [Apache Solr](https://solr.apache.org) via [Solarium](https://www.solarium-project.org) as search engine backend.

Currently **TYPO3 10.4 ELTS** and **TYPO3 11.5 LTS** is supported with the following system requirements:

Expand Down Expand Up @@ -43,17 +41,17 @@ To ensure it can best advise and assist users on technical and organisational is
for the following typical scenarios.

1. Users who have clearly defined questions relating to the use and development of Kitodo or Kitodo modules are well-served by the
[Kitodo mailing list](https://maillist.slub-dresden.de/cgi-bin/mailman/listinfo/kitodo-community). They will typically receive
[Kitodo mailing list](https://maillist.slub-dresden.de/mailman3/postorius/lists/kitodo-community.kitodo.org/). They will typically receive
helpful answers from the community or the Kitodo release managers within a short period of time. If this should be unsuccessful
for any reason, the Kitodo association office will address your matter to an experienced member institution. You do not need to
be a member of the association to use the mailing list. The [list archive](https://maillist.slub-dresden.de/pipermail/kitodo-community/)
be a member of the association to use the mailing list. The [list archive](https://maillist.slub-dresden.de/mailman3/hyperkitty/list/kitodo-community@kitodo.org/)
provides an impression of the topics and conversations.
2. For users who occasionally need more extensive advice and possibly also on-site practical assistance for Kitodo installation,
workflow modelling, etc., the Kitodo office maintains a list of voluntary mentors. Requests can be directed to these proven experts
from various libraries by the association office. More information is available from the [association office]([email protected]).
from various libraries by the association office. More information is available from the [association office](mailto:[email protected]).
3. For institutions that would like an initial and extensive introduction to Kitodo in the form of a product presentation or ongoing
support, in particular on-site, we are happy to provide a list of companies that to the best of our knowledge have already worked in these
fields. To obtain the company list, please also use the [association office address]([email protected]). Please bear in mind that the
fields. To obtain the company list, please also use the [association office address](mailto:[email protected]). Please bear in mind that the
association cannot provide further assistance in selecting service providers.

## Getting started
Expand Down

0 comments on commit 5bd3ff6

Please sign in to comment.