diff options
| author | Matthias Baumgartner <dev@igsor.net> | 2023-03-05 19:22:46 +0100 |
|---|---|---|
| committer | Matthias Baumgartner <dev@igsor.net> | 2023-03-05 19:22:46 +0100 |
| commit | af81318ae9311fd0b0e16949cef3cfaf7996970b (patch) | |
| tree | fb220da28bb7248ebf37ce09af5de88f2c1aaad4 /doc/source/index.rst | |
| parent | 7bf6b33fa6d6b901e4933bfe0b2a9939d7b3f3f3 (diff) | |
| parent | 8b460aa0232cd841af7b7734c91982bc83486e03 (diff) | |
| download | bsie-af81318ae9311fd0b0e16949cef3cfaf7996970b.tar.gz bsie-af81318ae9311fd0b0e16949cef3cfaf7996970b.tar.bz2 bsie-af81318ae9311fd0b0e16949cef3cfaf7996970b.zip | |
Merge branch 'mb/diogenes' into develop
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..9cf06fe --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,26 @@ + +Black Star Information Extraction +================================= + +A major advantage of the `Black Star File System (BSFS) <https://www.bsfs.io/bsfs/>`_ +is its ability to store various kinds of (meta)data associated with a file. +However, the BSFS itself is only a storage solution, +it does not inspect files or collect information about them. + +The Black Star Information Extraction (BSIE) package fills this gap by +extracting various kinds of information from a file and pushing that data to a BSFS instance. + +BSIE has the ability to process numerous file formats, +and it can turn various aspects of a file into usable information. +This includes metadata from a source file system, +metadata stored within the file, +and even excerpts or feature representations of the file's content itself. + +.. toctree:: + :maxdepth: 1 + + installation + architecture + api/modules + + |