From 21a715149eb5b2e0eb116e3e3517a7b43d763694 Mon Sep 17 00:00:00 2001 From: Kyattsukuro Date: Tue, 17 Mar 2026 17:12:43 +0100 Subject: [PATCH] Added README.md --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b89b233 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +# Fledermaus Formater + +The core of this project is an interpreter which takes instructions, defined in [/instructions](/instructions/), and uses them to apply operations upon an xlsx table. +For this was developed to serve the specific use case for formatting Bat Data, the instructions needed for said operation are monolithically included in this repository at this early version of the formatter. + +## Installing + +1. Download and run: [install.sh](install.sh) +2. Execute the application using `fledermaus-formater` from the terminal; the app is self-documented