Added README.md

This commit is contained in:
Kyattsukuro 2026-03-17 17:12:43 +01:00
parent 65d8ebce17
commit 21a715149e

9
README.md Normal file
View File

@ -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