Skip to content
This repository has been archived by the owner on Dec 24, 2023. It is now read-only.

Releases: chipsenkbeil/grus

v0.1.1 Release

17 Mar 07:05
Compare
Choose a tag to compare

Minor revision to add skeleton subcommand to grus that can be used to generate the beginnings of a theme (layout) or website.

v0.1.0 (assembly) release

07 Aug 04:50
Compare
Choose a tag to compare

Contains update for fat jars via sbt-assembly.

v0.1.0 release

07 Aug 01:40
Compare
Choose a tag to compare

First release of this project! Migrated the code from the Scala Debugger project, cleaned up and refactored quite a lot, and added some new features.

Running

Via binary

Grab one of the attached binaries and run via java -jar DOWNLOADED_JAR.jar. You can view help information by adding --help to the base jar or any of its commands. E.g. java -jar DOWNLOADED_JAR.jar --help or java -jar DOWNLOADED_JAR.jar generate --help.

Via sbt

To use in sbt (0.13.x) to generate your own content, add the following plugin:

addSbtPlugin("org.senkbeil" %% "sbt-grus" % "0.1.0")
  • sbt grusGenerate will generate the website and put the contents in an output directory
  • sbt grusServe will generate the website and start a server to display it locally
  • sbt grusPublish will publish the contents output from grusGenerate

You can add --help to any of the above commands to display help information for the specific command. E.g. sbt "grusGenerate --help".

Building a Theme

To use the API to create a custom theme, add the following dependency:

libraryDependencies += "org.senkbeil" %% "grus-layouts" % "0.1.0"

Examples

See the Scala Debugger docs module for an example of how to write a custom theme.

See the Scala Debugger grus.toml for an example of how to write a config file to fill in values.