punchcard

README

punchcard

A simple CLI for tracking time.

Getting started

Create a configuration file in $HOME/.punchcard.yaml:

# ~/.punchcard.yaml
# configuration for punchcard
storage:
	data: ~/punchcard/data.yaml

# round timestamps to this duration
# for details on the format see https://golang.org/pkg/time/#ParseDuration
roundTimestampsTo: 15m

Run the commands for instructions and/or examples:

punchcard help

punchcard examples

Developer documentation

Some short information on how to keep this going. (Because I tend to forget these things.)

Contributing

1. Create an issue.
2. Fork the repository.
3. Run tests (all should be OK): go test ./...
4. Write tests.
5. Run tests (some should fail).
6. Implement fix / feature.
7. Run tests (all should be OK again).
8. Commit, push and send a pull request, referencing the issue from step 1.

Releasing a new version

I use standard-version to generate the CHANGELOG.

1. Run standard-version --dry-run. Note the next version number.
2. Increase the version number in cmd/root.go and git add cmd/root.go.
3. Run standard-version --commit-all.
4. Run git push --follow-tags origin master.

LICENSE

GPLv3 (or later). See file LICENSE for the full license text.

Documentation

Overview

Copyright © 2020 Daniel J. Lauk <daniel.lauk@gmail.com>

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.