Moderizing dev environment.

- Use rake-deveiate.
 - Fixes for README
 - Add History, break out Manifest
 - Remove keyword expansion constant REVISION
 - Use current Configurability APIs instead of the (now ancient) methods
 - Whitespace changes

FossilOrigin-Name: a778fb275af99a238d9d2311cc601c58adf80e28bd68a37e06acdfb6efeb018d
This commit is contained in:
Mahlon E. Smith 2023-03-21 18:21:32 +00:00
parent 07c927e13a
commit 2682000224
18 changed files with 210 additions and 227 deletions

View file

@ -1,15 +1,26 @@
# Metronome
home
: https://code.martini.nu/fossil/symphony-metronome
docs
: https://martini.nu/docs/symphony-metronome
github_mirror
: https://github.com/mahlonsmith/symphony-metronome
## Description
Metronome is an interval scheduler and task runner. It can be used
locally as a cron replacement, or as a network-wide job executor.
Metronome is an interval scheduler and task runner. It can be used locally as a
cron replacement, or as a network-wide job executor. It is intended to be run
alongside Symphony, a Ruby AMQP event consumer.
Events are stored via simple database rows, and optionally managed
via AMQP events. Interval/time values are expressed with intuitive
English phrases, ie.: 'at 2pm', or 'Starting in 20 minutes, run every 10
seconds and then finish in 2 days', or 'execute 12 times during the next
minute'.
Events are stored via simple database rows, and optionally themselves managed
via AMQP events. Interval/time values are expressed with intuitive English
phrases, ie.: 'at 2pm', or 'Starting in 20 minutes, run every 10 seconds and
then finish in 2 days', or 'execute 12 times during the next minute'.
## Synopsis
@ -31,8 +42,8 @@ end
```
And here's a simplistic AMQP message broadcaster, using existing
Symphony connection information:
And here's a simplistic timed AMQP message broadcaster, using existing Symphony
connection information:
```
#!ruby
@ -156,19 +167,58 @@ gem install symphony-metronome
## Contributing
You can check out the current development source with Mercurial
[here](http://code.martini.nu/symphony-metronome), or via a mirror:
You can check out the source via Fossil from the following uri:
* github: https://github.com/mahlonsmith/Symphony-Metronome
* SourceHut: https://hg.sr.ht/~mahlon/Symphony-Metronome
% fossil clone https://code.martini.nu/fossil/symphony-metronome
or via its GitHub mirror at:
% git clone https://github.com/mahlonsmith/Symphony-Metronome
After checking out the source, run:
```
$ rake
```
$ gem install -Ng
$ rake setup
This task will run the tests/specs and generate API documentation.
This will install dependencies, and do any other necessary setup for
development.
Please report any issues
[here](https://code.martini.nu/fossil/symphony-metronome/tktnew).
## Authors
- Mahlon E. Smith <mahlon@martini.nu>
## License
Copyright (c) 2014-2023 Mahlon E. Smith
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the author/s, nor the names of the project's
contributors may be used to endorse or promote products derived from this
software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
If you use [rvm](http://rvm.io/), entering the project directory will
install any required development dependencies.