summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:48:59 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 05:48:59 +0000
commitc484829272cd13a738e35412498e12f2c9a194ac (patch)
treea1f5ec09629ee895bd3963fa8820b45f2f4c574b /README.md
parentInitial commit. (diff)
downloadliborcus-c484829272cd13a738e35412498e12f2c9a194ac.tar.xz
liborcus-c484829272cd13a738e35412498e12f2c9a194ac.zip
Adding upstream version 0.19.2.upstream/0.19.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a7b044
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+Orcus - library for processing spreadsheet documents.
+=====================================================
+
+Orcus is a library that provides a collection of standalone file processing
+filters. It is focused primarily on providing filters for spreadsheet documents.
+
+The library currently includes the following import filters:
+
+* Microsoft Excel 2007 XML
+* Microsoft Excel 2003 XML
+* Open Document Spreadsheet
+* Plain Text
+* Gnumeric XML
+* Generic XML
+* Apache Parquet (via Apache Arrow library)
+
+The library also includes low-level parsers for the following:
+
+* CSV
+* CSS
+* XML
+* JSON
+* YAML (experimental)
+
+These parsers are all implemented as C++ templates and require a handler class
+passed as a template argument so that the handler class receives various
+callbacks from the parser as the file is being parsed.
+
+## API Documentation
+
+* [Official API documentation](https://orcus.readthedocs.io/en/latest/) for
+ general users of the library.
+
+## Pages
+
+* [Old packages](OLD-DOWNLOADS.md)
+* [For contributors](CONTRIBUTING.md)