From 565e199f3348d6a8c9ad8f62ebb00f7d925ccdaf Mon Sep 17 00:00:00 2001 From: Peter Kurfer Date: Fri, 12 Nov 2021 13:14:12 +0100 Subject: [PATCH 1/2] Update Readme --- README.md | 43 +++++++++++++++++++++++++++++++------------ 1 file changed, 31 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0cd22de..cb678e1 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,28 @@ [![Actions Status](https://github.com/baez90/goveal/workflows/Go/badge.svg)](https://github.com/baez90/goveal/actions) -Goveal is very small an very simple tool that reads Markdown from a given file, renders it into a HTML template and serves it as local HTTP server. -Right now Goveal uses Reveal.js 4.0.2 to create presentations and therefore also includes all features of Reveal.js 4.0.2. +Goveal is very small and very simple tool that reads Markdown from a given file, renders it into a HTML template and +serves it as local HTTP server. Right now Goveal uses Reveal.js 4.1.2 to create presentations and therefore also +includes all features of Reveal.js 4.1.2. + +## Install + +The easiest and fastest way to install Goveal is to use a pre-built binary from the [releases](https://github.com/baez90/goveal/releases/latest). + +If you have Go in the latest version installed you can also install it like so: + +```bash +// latest and greatest +go install github.com/baez90/goveal@latest + +// release +go install github.com/baez90/goveal@v0.0.7 +``` + +_Note: Releases before v0.0.7 are based on Go 1.15 and used Pkger to embed Reveal.JS and cannot be installed with `go install`._ ## Usage -The easiest way to use `goveal` is to download a release, and run it from your `$PATH`. - ```bash goveal serve ./slides.md ``` @@ -28,19 +43,23 @@ goveal serve ./slides.md ## Config -Goveal supports multiple configuration mechanisms. -It tries to load a configuration file from `$HOME` or from `.` i.e. `$HOME/goveal.yaml` or `$HOME/goveal.yml` or `./goveal.yaml` and so on. +Goveal supports multiple configuration mechanisms. It tries to load a configuration file from `$HOME` or from `.` +i.e. `$HOME/goveal.yaml` or `$HOME/goveal.yml` or `./goveal.yaml` and so on. -Most options that can be set via commandline flags can also be set via configuration file (actually all but the `--config` switch does not make sense in the configuration file, does it? :wink:). -It is more a convenience feature to be able to set a theme and so on and so forth for the presentation without having to pass it every time as parameter. +Most options that can be set via commandline flags can also be set via configuration file (actually all but +the `--config` switch does not make sense in the configuration file, does it? :wink:). It is more a convenience feature +to be able to set a theme and so on and so forth for the presentation without having to pass it every time as parameter. -Furthermore goveal supports configuration hot reloading i.e. you can play around with different themes and the rendered theme will be changed whenever you hit the save button! +Furthermore goveal supports configuration hot reloading i.e. you can play around with different themes and the rendered +theme will be changed whenever you hit the save button! See also an example at [`./examples/goveal.yaml`](./examples/goveal.yaml). ### Custom CSS -To add custom CSS as theme overrides use a config file and add the `stylesheets` property. -It takes a list of relative (mandatory!) paths to CSS files that are included automatacally after the page was loaded so that they really overload everything added by Reveal and plugins. +To add custom CSS as theme overrides use a config file and add the `stylesheets` property. It takes a list of relative ( +mandatory!) paths to CSS files that are included automatacally after the page was loaded so that they really overload +everything added by Reveal and plugins. -the sample configuration file [`./examples/goveal.yaml`](./examples/goveal.yaml) also contains a sample how to add custom CSS. +the sample configuration file [`./examples/goveal.yaml`](./examples/goveal.yaml) also contains a sample how to add +custom CSS. -- 2.45.2 From aad73c8e36e351089a0cd3b8005fe38a9f689f2c Mon Sep 17 00:00:00 2001 From: Renovate Bot Date: Fri, 12 Nov 2021 12:21:27 +0000 Subject: [PATCH 2/2] chore(deps): add renovate.json --- renovate.json | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 renovate.json diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000..f45d8f1 --- /dev/null +++ b/renovate.json @@ -0,0 +1,5 @@ +{ + "extends": [ + "config:base" + ] +} -- 2.45.2