lainiwa/buglog

BugLog - log what's bugging you
###############################

.. toctree::
   :hidden:
   :maxdepth: 1

   reference

This TUI task tracker is meant to be used as

* pills intake log
* pain diary
* anxiety/CBT diary
* calorie counter
* *and whatever else*

**Note:** the project is pre-alpha quality.


Installation
============
To install the Buglog,
run any of these commands in your terminal (pick what fits you):

.. code-block:: console

    $ pip install --user 'git+https://github.com/lainiwa/buglog'

    $ pipx install 'git+https://github.com/lainiwa/buglog'  # newer versions of pipx

    $ pipx install --spec 'git+https://github.com/lainiwa/buglog.git' buglog  # legacy pipx


First run
=========
Upon the first invocation the tool will automatically

* download fzf binary
* and create a template configuration at ``~/.config/buglog/config.py`` (respecting your XDG settings)


Usage
=====
Blah blah blah


Welcome to Buglog's documentation!
==================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`