Commit d8d65e99 authored by PTSEFTON's avatar PTSEFTON
Browse files

More detail in README

parent 44d6b129
......@@ -14,7 +14,13 @@ via automatically generated spreadsheets and for creating static HTML repositori
Calcyte targets the [Draft DataCrate Packaging format v0.2](https://github.com/UTS-eResearch/datacrate/blob/new_draft/0.2/spec/0.2/data_crate_specification_v0.2.md).
At this stage Calcyte does not Bag content, it jsut creates *Working DataCrates*.
## Usage
## Installation
(TODO)
- Install Siegfreid using the [instructions](https://github.com/richardlehane/siegfried/wiki/Getting-started).
## Usage / instructions
To run calcyte on a group of directories pass it a list of directories
......@@ -28,6 +34,16 @@ To run calcyte on a group of directories pass it a list of directories
```
Calcyte will generate a CATALOG.xlsx file in each directory.
Calcyte will generate:
- a CATALOG_$dir.xlsx file in each directory (this is for humans to fill in with
metadata about the data)
- An index.html file summarizing the data using metadata from CATALOG_$dir.xlsx
- A CATALOG.json file containing JSON-LD metadata derived from the CATALOG* files plus some basic file-format information.
See the examples in ```test_data```.
TODO: Instructions for filling in the CATALOG files.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment