<commit_before><commit_msg>Progress on README and usage documentation<commit_after>## Overview

I created Qtask to quickly record work/tasks I have done (or need to) from the command line, group them based on project, and easily generate reports.  Most parts are optional, but each element recorded has an ID, label, a datestamp, time committed, and associated project.

The entries themselves are stored in a SQLite3 database (nothing fancy, just a file on disk.)


## Usage

I tried to make the usage follow natural language as much as possible rather than use a lot of command-line switches.

First, initialize Qtask:

```
    qtask init
```

Optionally, create a project:

```
    qtask add project annotation
```

Record work done, a meeting, whatever:

```
    qtask log "Conference call with review panel"
```

Or, if you want to link the task to a project when you log it:

```
    qtask log annotation "Added parsing script for latest version of tool X"
```

### Listing things

Show the projects you've added

```
    qtask list projects
```

List all work for a project (most recent first)

```
    qtask list annotation work
```

You can also do time intervals (deltas)

```
    qtask list work in last 30 days
```

And, of course, limit these by project too

```
    qtask list annotation work in last 1 week
```

### Generating reports (graphics)

Nothing here yet


## Help

Get help on any command by using help, then the command name, such as:

```
qtask help init
```


## Getting the code

The best way to get the code for now is to just clone it:

```
    git clone https://github.com/jorvis/qtask.git
```

Or you can get a zip file of the most current code at:

```
    https://github.com/jorvis/qtask/archive/master.zip
```

## Problems?

If you encounter any issues or have suggestions,  please submit to the [Issue tracking system](https://github.com/jorvis/qtask/issues)


Contributing
============

I welcome contributions, either in the form of code (pull requests) or suggestions e-mailed to me.
{'fraction_non_alphanumeric': 0.08848245180425111, 'fraction_numerical': 0.001977261492832427, 'mean_word_length': 3.7623529411764705, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3447132', 'n_tokens_mistral': 601, 'n_tokens_neox': 558, 'n_words': 287}