From 26a619dc7bd8cd26c39d9ccae497495c9a084e6f Mon Sep 17 00:00:00 2001 From: Peter Kurfer Date: Fri, 12 Nov 2021 13:14:12 +0100 Subject: [PATCH] Update Readme and Github actions pipeline --- .github/workflows/go.yml | 4 ++-- README.md | 44 +++++++++++++++++++++++++++++----------- 2 files changed, 34 insertions(+), 14 deletions(-) diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index b4e63b0..2838b09 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -9,10 +9,10 @@ jobs: runs-on: ubuntu-latest steps: - - name: Set up Go 1.15 + - name: Set up Go 1.17 uses: actions/setup-go@v2 with: - go-version: '^1.15' + go-version: '^1.17' id: go - name: Check out code into the Go module directory diff --git a/README.md b/README.md index 0cd22de..58795c3 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,29 @@ [![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 build your own version of Goveal: + +```shell +task build +``` + +Requirements: + +- [task](https://taskfile.dev/) +- _Optional:_ [goreleaser](https://goreleaser.com/) (for `task snapshot-release` to build all binaries) + +_Note: All script tasks in the [Taskfile.yml](Taskfile.yml) are meant to be executed with Linux/MacOS. Binaries for Windows are provided but not tested!_ ## 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 +44,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.