= Eurobench Software documentation :imagesdir: modules/ROOT/images :sourcedir: modules/ROOT/pages :source-highlighter: highlightjs :icons: font :linkattrs:
This document gathers documentation on software aspects related to the http://eurobench2020.eu/[Eurobench] project.
All material is automatically deployed to this https://eurobench.github.io/[github Website].
== Main content pointers
The principle documentation pages are the following:
== Modification Instructions
All the documentation is subject to evolution according to http://eurobench2020.eu/[Eurobench] needs. If you identify errors, or want to provide additional material, please use traditional GitHub tools:
== Content deployment
The repository is using https://antora.org/[Antora] to generate a static website from this content. Antora requires 3 components:
General information on the Antora concepts can be found https://matthewsetter.com/antora/three-core-concepts/[here].
All the deployment is then handled through the link:.github/workflows/build_deploy.yml[GitHub actions] of this website.
== Additional Tools
To generate locally the documentation (under Linux), type from the repository root the command make
.
It requires make
and asciidoctor
installed locally.
WARNING: Look for html pages in folder modules/ROOT/pages
.
The link towards other pages may not be working locally.
[cols=".^30, .^80", grid=none,frame=none] |====== |image:logo_eurobench.png["eurobench logo", width=200, role=left] | Supported by Eurobench - the European robotic platform for bipedal locomotion benchmarking. More information: http://eurobench2020.eu/[eurobench2020.eu]. | image:logo_eu.png["eu flag",float=left,width=100] | This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement no. No 779963. |======