Compare commits

..

No commits in common. "7f29ee8c3ab2bd13b692b3af5029e541501d5082" and "a3d80de33c40f851b4a3028f9fab5ee86bd41831" have entirely different histories.

View File

@ -1,50 +1,8 @@
# onPoint # OnPoint
## Installation ## Installation
This program is meant to be used as a git submodule of your actual presentation project, therefore you need to add it: You have to have python3 and pandoc installed.
$ git submodule add -b release git@path-to-onpoint.git
Make sure to have python3 and pandoc installed.
Next, we can install all requirements:
$ cd onpoint $ cd onpoint
$ pip3 install -r requirements.txt $ pip3 install -r requirements.txt
## The Project Structure
We recommend you to structure your project directory like this:
├── images
├── layouts
│   ├── default.html
│   ├── root.html
│   └── titlepage.html
├── meta.yml
├── onpoint
│ ├── main.py
│ ├── README.md
│ └── requirements.txt
├── slides
│   ├── chapter1.de.md
│   ├── chapter1.en.md
│   ├── chapter2.de.md
│   └── chapter2.en.md
├── slides.de.html
├── slides.en.html
├── slides.yml
└── styles
└── style.css
* `onpoint` is where this program lives.
* In `layouts`, you can create custom templates for your slides.
* `meta.yml` is there to add language-specific meta information (like title internationalization).
* `slides.yml` will contain a list of all chapters to be included. Their content is expected to live in files inside the `slides` folder.
* You can store your usual web resources in the folders `styles` and `images`.
## Updating onPoint
In order to update the version of onPoint in an existing project, run the following command:
$ git submodule update --recursive --remote