aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorMatthew Lemon <matt@matthewlemon.com>2022-06-23 11:49:47 +0100
committerMatthew Lemon <matt@matthewlemon.com>2022-06-23 11:49:47 +0100
commit3b21ff4124bc2464bc3224873fbbde035f3996d7 (patch)
tree1e2f0b5f252778254ee0244c43992ad4c965a545 /README.md
parentupdated with documentation site address (diff)
updated README
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 13 insertions, 9 deletions
diff --git a/README.md b/README.md
index b031667..cd4822e 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,17 @@
![Tests](https://github.com/hammerheadlemon/datamaps/workflows/Tests/badge.svg)
-This software is a CLI UI layer for
-[bcompiler-engine](https://github.com/hammerheadlemon/bcompiler-engine). It
-allows for easy access to adapters available within `bcompiler-engine` and is
-intended to be packaged using a packaging application such as `PyInstaller` and
-thus making `bcompiler-engine` palatable to non-technical users, and users who
-do not have access to a Python installation.
+## Introduction
+`datamaps` is a command line tool, written in Python, which facilitates the collection of data using Excel as the 'form'. It accepts that Excel files are freely distributable, easy to understand and already well integrated in the non-technical office environment.
-Details and documentation, including links to the downloadable version of this software are be
-found at [Datamaps - Twenty Four
-Software](https://datamaps.twentyfoursoftware.com).
+The tool uses a concept a *datamap*, which is simple, user-created CSV file which maps cell references within Excel 'templates'. The datamap concept makes it easy to design pretty Excel spreadsheets with blank cells (the 'template') intended for the user to complete - the cell references in the datamap inform the `datamaps` program where it should expect to find user-entered data. At this point, the output is another *master* spreadsheet which contains all the data from each completed template compiled into a single table. This is then used by other tools for further analysis.
+
+The documentation found at [Datamaps - Twenty Four Software](https://datamaps.twentyfoursoftware.com) gives a more detailed explanation.
+
+## Installation
+
+`pip install datamaps`
+
+## Bugs and issues
+
+Please report bugs as [Github issues](https://github.com/yulqen/datamaps/issues).