diff --git a/CHANGELOG.md b/CHANGELOG.md index 9cd887f..f9bccf2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,19 @@ # Change Log -All notable changes to this project will be documented in this -file. This change log follows the conventions of [keepachangelog.com]. +*All notable changes to this project will be documented in this +file. This change log follows the conventions of +[keepachangelog.com].* ## [Unreleased] ### Changed +## [1.0.0] - 2020-06-20 +### Changed + * This is the first release. [keepachangelog.com]: http://keepachangelog.com/ +[Unreleased]: https://github.com/mzuther/moccafaux/tree/develop -[Unreleased]: https://github.com/mzuther/moccafaux/tree/develop -[1.0.0]: https://github.com/mzuther/moccafaux/commits/v1.0.0 +[1.0.0]: https://github.com/mzuther/moccafaux/commits/v1.0.0 diff --git a/CODE_OF_CONDUCT.markdown b/CODE_OF_CONDUCT.md similarity index 100% rename from CODE_OF_CONDUCT.markdown rename to CODE_OF_CONDUCT.md diff --git a/README.md b/README.md index 8f618c7..c1e3be2 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,78 @@ -# moccafaux +# MoccaFaux -FIXME: description +*Adapt power management to changes in the environment.* -## Installation +MoccaFaux can be used to prevent the activation of screen savers and +power-saving modes when certain conditions are met. It was inspired +by [caffeine], but is much more flexible. -Download from http://example.com/FIXME. +In fact, MoccaFaux is a scheduler that executes commands, records +their exit code and executes other commands depending on these exit +codes: -## Usage +1. execute commands and record their exit code (the commands as well + as their number are user-defined) -FIXME: explanation +1. assign exit codes to user-defined tasks (such as `:control-dpms`, + again user-defined) - $ # please adapt "1.0.0" to the version you downloaded (for more info on - $ # MALLOC_ARENA_MAX, see https://issues.apache.org/jira/browse/HADOOP-7154) - $ MALLOC_ARENA_MAX=4 java -jar ./target/uberjar/moccafaux.core-1.0.0-standalone.jar +1. for each task, check whether any of the executed commands had a + **zero exit code** -## Options +1. in case the result of a task differs from the last run, execute a + command depending on the result (you probably guessed it, commands + are user-defined) + +MoccaFaux is so flexible that it could be used for other tasks, for +example compiling an application if files in a directory change. In +practice, you might be better advised to use dedicated software and +APIs like [Gulp.watch] and [inotify]. + +## The name -FIXME: listing of options this app accepts. +As this application was conceived as a substitue for [caffeine], I +originally called it *Muckefuck* (pronounced [ˈmʊkəfʊk]). This is the +colloquial German term for [coffee substitute]. -## Examples +However, most English speakers would consider this name to contain a +certain bad word (which it doesn't). I liked the name though, so I +changed it to *Mocca faux*, which might be the French origin for +*Muckefuck*. -... +## Installation + +You need an installation of Java SE 11 (any version for SE 8 probably +works just fine). + +If `git` and `lein` are installed on your system, then run this: -### Bugs +```bash +git clone https://github.com/mzuther/moccafaux.git +cd moccafaux +lein clean && lein uberjar +``` -... +Or simply download a pre-compiled JAR file from the [releases]. + +## Usage -### Any Other Sections -### That You Think -### Might be Useful +Open a shell and locate to the MoccaFaux directory. Then execute: + +```bash +# for MALLOC_ARENA_MAX, see https://issues.apache.org/jira/browse/HADOOP-7154) +MALLOC_ARENA_MAX=4 java -jar ./target/uberjar/moccafaux.jar +``` + +## Options + +*To do done.* + +For now, copy `config-MOVE-ME.json` to +`$HOME/.config/moccafaux/config.json` and edit to taste. ## License -Copyright © 2020 Dr. Martin Zuther +Copyright (c) 2020 [Martin Zuther] This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at @@ -45,3 +85,14 @@ Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html. + +Thank you for using free software! + + +[caffeine]: https://launchpad.net/caffeine +[coffee substitute]: https://en.wikipedia.org/wiki/Coffee_substitute +[inotify]: https://en.wikipedia.org/wiki/Inotify +[Gulp.watch]: https://gulpjs.com/docs/en/getting-started/watching-files + +[Martin Zuther]: http://www.mzuther.de/ +[releases]: https://github.com/mzuther/moccafaux/releases