Skip to content

Commit

Permalink
Modified README to link an example.
Browse files Browse the repository at this point in the history
  • Loading branch information
rbejar committed Nov 30, 2023
1 parent 7dcbb4c commit c4f1b02
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# odpmkd
A small set of tools to process OpenDocument Presentation files (ODP), and to transform them to markdown.
It will work acceptably for the "lecture notes style" slides, AKA "presentation-as-a-document" style: mostly text structured in bullet points. It will
not work well at all for more "presentation style" slides, where the visual aspect and the arrangement of elements
in the slides is important.
It will work acceptably for the "lecture notes style" slides, AKA "presentation-as-a-document" style: mostly text structured in bullet points. It will not work well at all for more "presentation style" slides, where the visual aspect and the arrangement of elements in the slides is important.

- `odptools` takes an odp file, and produces a cleaner version of that file.
- `odpmkd` takes an odp file and produces a markdown file trying to preserve its contents.

You can see an example of the results in these [lecture notes, in Spanish, about Scrum](https://unizar-30248-geprosoft.github.io/scrumnotes/) which are used in a software projects management course in the [Universidad Zaragoza](https://www.unizar.es/), [Grado en Ingeniería Informática](https://estudios.unizar.es/estudio/ver?id=148). Those lecture notes have been processed with **odpmkd** and published using [MkDocs](https://www.mkdocs.org).

## Build
Read the ci.yml script for details on how to build.

Expand Down

0 comments on commit c4f1b02

Please sign in to comment.