Commit 9b840c17 authored by PTSEFTON's avatar PTSEFTON
Browse files

Bit of an update to README

parent 2823c740
......@@ -16,14 +16,15 @@ Calcyte is a toolkit to implement the [RO-Crate] specification:
spreadsheets (CATALOG.xlsx), to create `ro-crate-metadata.jsonld` files
3. Packaging data in BagIt format, and optionally zipping it.
This version of Calcyte targets the [R0-Crate Spec, v0.2](https://github.com/UTS-eResearch/RO-Crate/blob/master/spec/0.3/data_crate_specification_v0.3.md).
This version of Calcyte targets the [R0-Crate Spec, v1.0](https://researchobject.github.io/ro-crate/1.0/).
## Installation
- Install [node.js](https://nodejs.org/en/)
NOTE: These instructions are for MacOs - adapt as necessary.
NOTE: Bagit is no longer required!
- Install the [BagIt](https://github.com/LibraryOfCongress/bagit-java)
`brew install bagit`
- Install [node.js](https://nodejs.org/en/)
- Install Siegfreid using the [instructions](https://github.com/richardlehane/siegfried/wiki/Getting-started).
......@@ -36,11 +37,6 @@ This version of Calcyte targets the [R0-Crate Spec, v0.2](https://github.com/UTS
npm link
## Get set up for development use
RO-Crate
......@@ -51,7 +47,7 @@ RO-Crate
### Usage
Calcyfy creates RO-Crates with an HTML entry-point in r
Calcyfy creates RO-Crates with an HTML entry-point in ro-crate-preview.html file.
Usage:
......@@ -88,7 +84,7 @@ One directory:
```
calcyfy -r test_data/sample/
calcyfy test_data/Glop_Pot -r -c /
calcyfy test_data/Glop_Pot -r -c https://data.research.uts.edu.au/examples/ro-crate/examples/src/crate.js
```
This will:
......@@ -99,7 +95,7 @@ This will:
All the sample directories:
```
calcyfy -r test_data/*
calcyfy -r test_data/* -c https://data.research.uts.edu.au/examples/ro-crate/examples/src/crate.js
```
Calcyte will generate:
......
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