Link to user-relevant information in "Commentary"
This commit is contained in:
parent
0134ac9823
commit
e651821d0f
|
@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
|
|||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.2.1] - 2020-07-06
|
||||
### Fixed
|
||||
* Package long description in the package menu
|
||||
|
||||
## [0.2.0] - 2020-07-06
|
||||
### Changed
|
||||
* Name of project changed from `chronometrist-goals` to `chronometrist-goal`. All definitions use the package name as the prefix, to help meet MELPA's needs.
|
||||
|
|
2
Cask
2
Cask
|
@ -3,7 +3,7 @@
|
|||
|
||||
(package
|
||||
"chronometrist-goals"
|
||||
"0.1.0"
|
||||
"0.2.1"
|
||||
"Adds support for time goals to Chronometrist")
|
||||
|
||||
(depends-on "emacs" "25.1")
|
||||
|
|
|
@ -51,7 +51,13 @@ The custom variable `chronometrist-goal-alert-functions` is a list of functions
|
|||
|
||||
You can add or remove functions from this list to customize the times at which you are notified. The functions added to the list by default are tiny (7~9 lines) and (hopefully) easy for an interested user to base their own alert functions on.
|
||||
|
||||
### More
|
||||
A user desiring even greater control may define their own versions of `chronometrist-goals-run-alert-timers` and `chronometrist-goals-stop-alert-timers` (preferably using them as a template) and add them to the desired hooks.
|
||||
|
||||
## Roadmap/Ideas
|
||||
* clear notifications on file change event
|
||||
* define types for custom variables
|
||||
* clock in -> go over the goal, get the 'exceeding' -> clock out, file changes, the exceed alert is shown again
|
||||
|
||||
## Contributions and contact
|
||||
Feedback and MRs very welcome. 🙂
|
||||
|
|
|
@ -5,7 +5,7 @@
|
|||
;; Keywords: calendar
|
||||
;; Homepage: https://github.com/contrapunctus-1/chronometrist
|
||||
;; Package-Requires: ((emacs "25.1") (alert "1.2") (chronometrist "0.5.0"))
|
||||
;; Version: 0.2.0
|
||||
;; Version: 0.2.1
|
||||
|
||||
(require 'chronometrist-queries)
|
||||
(require 'alert)
|
||||
|
@ -20,17 +20,9 @@
|
|||
;; For more information, please refer to <https://unlicense.org>
|
||||
|
||||
;;; Commentary:
|
||||
;; Add support for time goals to Chronometrist
|
||||
|
||||
;;; It is hoped that `chronometrist-goals-alert-functions' provides a good balance
|
||||
;;; of flexibility and ease of use for the majority of use cases. A
|
||||
;;; user desiring even greater control may define their own versions
|
||||
;;; of `chronometrist-goals-run-alert-timers' and `chronometrist-goals-stop-alert-timers' (preferably using
|
||||
;;; them as a template) and add them to the desired hooks.
|
||||
|
||||
;; TODO -
|
||||
;; * clear notifications on file change event
|
||||
;; * define types for custom variables
|
||||
;; * clock in -> go over the goal, get the 'exceeding' -> clock out, file changes, the exceed alert is shown again
|
||||
;; For information on usage and customization, see https://github.com/contrapunctus-1/chronometrist-goal/blob/master/README.md
|
||||
|
||||
;;; Code:
|
||||
|
||||
|
|
Reference in New Issue