Skip to content

Commit

Permalink
Update README.md regarding documentation links
Browse files Browse the repository at this point in the history
this commit adds a subtopic "documentation" that links to /docs in this repo. addresses a comment by @peterstadler  Edirom#472 (review)

Refs #Edirom#415
  • Loading branch information
krHERO authored and Silke Reich committed Dec 11, 2024
1 parent 2bc5c54 commit c15d1cc
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

**[Showcases](https://github.com/Edirom/Edirom-Online#showcases)
[Get started](https://github.com/Edirom/Edirom-Online#get-started)
[Documentation](https://github.com/Edirom/Edirom-Online#documentation)
[Dependencies](https://github.com/Edirom/Edirom-Online#dependencies)
[Roadmap](https://github.com/Edirom/Edirom-Online#roadmap)
[Contributing](https://github.com/Edirom/Edirom-Online#contributing)
Expand Down Expand Up @@ -97,6 +98,13 @@ When you have your system prepared with all Sencha Cmd prerequisites or you have
* at `http://localhost:8080/exist/apps/dashboard/admin#` (signed-in) go to "Package Manager" then "Upload" and select the xar file which (supposed above build-method was used) was built at `/PATH_TO_LOCAL_EDIROM_EDITION_EXAMPLE_REPO/build/EditionExample-0.1.xar`
* in **eXist-db Package Manager** click on the "Edirom Online" entry - you will be directed to the running Edirom at `http://localhost:8080/exist/apps/Edirom-Online/index.html`

## Documentation

Some useful information regarding documentation is captured in the [docs] folder of this repo. It contains:
* [Customize] Edirom Online and content
* Edirom Online – [Release Workflow]
* [Setup Edirom Online] on a local machine

## Dependencies

Edirom Online depends heavily on the JavaScript framework [Ext JS] which is included in parts in our code base. We use Ext JS 4.2.1 in the GPL version. Edirom Online also includes the [Raphaël] javascript library (MIT License) and the [ACE] editor (BSD license).
Expand Down Expand Up @@ -152,6 +160,10 @@ Edirom Online is released to the public under the terms of the [GNU GPL v.3] ope
[Bargheer: Edition]: https://github.com/Edirom/Bargheer-Edition
[eXist-db]: https://exist-db.org/
[Verovio]: https://www.verovio.org/index.xhtml
[docs]: /docs
[Customize]: docs/customize.md
[Release Workflow]: docs/release-workflow.md
[Setup Edirom Online]: docs/setup.md
[Ext JS]: https://www.sencha.com/products/extjs
[Raphaël]: http://raphaeljs.com
[ACE]: http://ace.ajax.org
Expand Down

0 comments on commit c15d1cc

Please sign in to comment.