paritybit.ca

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

commit 4250cebfa76b4d98ceeccdb3ac9ad2d5e023fb61
parent 6ad5adbed8cccb28a9963b3150806ee769a9a26e
Author: Jake Bauer <jbauer@paritybit.ca>
Date:   Sun, 14 Jun 2020 20:39:28 -0400

Add kontaktdb project page

Diffstat:
Mpages/projects.md | 2++
Apages/projects/kontaktdb.md | 69+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 71 insertions(+), 0 deletions(-)

diff --git a/pages/projects.md b/pages/projects.md @@ -27,6 +27,8 @@ anymore. <li><a href="projects/usrmnt">usrmnt</a>: A small utility to mount, unmount, unlock, etc. your devices from the terminal with an intuitive command syntax and using an intuitive text-based UI.</li> + <li><a href="projects/kontaktdb">kontaktdb</a>: Store, retrieve, and edit + basic contact information in plain text. <li><a>Gopherize [WIP]</a></li> <li><a>Geminize [WIP]</a></li> </ul> diff --git a/pages/projects/kontaktdb.md b/pages/projects/kontaktdb.md @@ -0,0 +1,69 @@ +## kontaktdb + +[//]: # "kontaktdb is a contact management application that I made in order to store, retrieve, and edit basic contact information in plain text because I wasn't happy with the existing software available." + +[//]: # "main.min.css" + +[//]: # "Why Does This Exist?; Download; Installing, Using, and Customizing; Contributing" + +kontaktdb (/ˈkɑntækt diː biː/ or "contact D B") is a contact management +application that I made in order to store, retrieve, and edit basic contact +information in plain text because I wasn't happy with the existing software +available. + +Right now it supports adding the following contact information: + +* Name +* Email address + +There are plans to add more supported categories and custom categories in the +future. + +kontaktdb is a simple shell script not much larger than a hundred lines of code. +It is POSIX compliant except for the use of `sed -i`. This means it should run +on almost every *nix environment including Linux distributions and BSDs. + +The program used to be called 'kontakt' but then I found out the KDE project has +a project called 'Kontact' and I opted to rename to reduce confusion. I am not +overly attached to the name so if you've come up with something better, please +let me know. + +### Why Does This Exist? + +I didn't like the existing options for managing contacts on the command line. +Programs like abook and khard are nice, but I wanted something much, much +simpler since I didn't need the complexity offered by the other options. + +The goals for this program are: + +* Contact database entirely in plain text with tab-delimited fields. +* Support for contact names and emails (possibly more later, but not much more). +* Really simple set of commands to interact with the database. + +The overarching goal of the project is to provide a really simple way to manage +basic contact information. There is no planned support for anything more than +plain text with each line having tab-delimited fields representing one contact; +if you need CardDAV support or anything else like that, this is not the +application for you. + +### Download + +The latest release can be downloaded on [the project release +page](https://git.sr.ht/~jbauer/kontaktdb/refs). To get the most up-to-date, +bleeding edge version, clone [the git +repository](https://git.sr.ht/~jbauer/kontaktdb). + +### Installing, Using, and Customizing + +Please refer to the README file for instructions on installating, using, and +customizing the software. + +### Contributing + +If you would like to submit a bug report, suggest a feature, or have any other +feedback or contribution that you are thinking about submitting, you can post it +on the project’s [public mailing list](mailto:~jbauer/kontaktdb@lists.sr.ht). + +If you’ve made changes to the code which you wish to share with me, I accept +contributions through email which you can learn how to do using the +[git-send-email.io](https://git-send-email.io) website.