diff --git a/README.md b/README.md index 724eb1e..3674afa 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This project captures a number of demos, and sample set of content for [compliance-trestle](https://ibm.github.io/compliance-trestle). Each of the folders in the top level of this project is a self contained demonstration. -These demos are designed to work with trestle version 1.0.x +These demos are designed to work with trestle version 3.x.x ## Using / management of this repository diff --git a/trestle_sdk_examples/README.md b/trestle_sdk_examples/README.md index 7db71ca..0b611c8 100644 --- a/trestle_sdk_examples/README.md +++ b/trestle_sdk_examples/README.md @@ -1,7 +1,31 @@ -# Trestle sdk examples +# Trestle SDK examples -A container for a set of simpler examples of using the trestle sdk. +A container for a set of simpler examples of using the trestle SDK. -## Creating a catalog +## Prerequisites +Download this repo + +``` +> cd +> mkdir git +> cd git +> git clone https://github.com/oscal-compass/compliance-trestle-demos.git +``` + +Install compliance trestle, ideally in a python virtual environment. + +``` +> cd +> python -m venv venv.compliance-trestle-demos +> source venv.compliance-trestle-demos/bin/activate +> cd git/compliance-trestle-demos +> make install +``` + +## Running the demo +``` +> cd trestle_sdk_examples +> python create_a_catalog.py +``` Running `python create_a_catalog.py` will first try and fail to create a catalog (by failing to provide required attributes), then create a catalog, followed by writing it out to disk.