diff options
| author | Adam Janovsky | 2022-05-20 15:25:28 +0200 |
|---|---|---|
| committer | Adam Janovsky | 2022-05-20 15:25:28 +0200 |
| commit | 99768447af7031d4ceb982ba58f49fcf8d4c4591 (patch) | |
| tree | 232c8453fff682f484c66b599d7ef7e9cd4d3b33 /docs/quickstart.md | |
| parent | dab67350a43c67d16d808286eb709b4354692539 (diff) | |
| download | sec-certs-99768447af7031d4ceb982ba58f49fcf8d4c4591.tar.gz sec-certs-99768447af7031d4ceb982ba58f49fcf8d4c4591.tar.zst sec-certs-99768447af7031d4ceb982ba58f49fcf8d4c4591.zip | |
update docs
Diffstat (limited to 'docs/quickstart.md')
| -rw-r--r-- | docs/quickstart.md | 29 |
1 files changed, 22 insertions, 7 deletions
diff --git a/docs/quickstart.md b/docs/quickstart.md index 48f7f1ce..14121212 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -1,18 +1,29 @@ # Quickstart +::::{tab-set} + +:::{tab-item} Common Criteria 1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)). 2. Use ```python dset = CCDataset.from_web_latest() ``` +to obtain to obtain freshly processed dataset from [seccerts.org](https://seccerts.org). -(Common Criteria) or +3. Play with the dataset. See [example notebook](./notebooks/examples/common_criteria.ipynb). +::: +:::{tab-item} FIPS 140 +1. Install the latest version with `pip install -U sec-certs` (see [installation](installation.md)). +2. Use ```python dset = FIPSDataset.from_web_latest() ``` +to obtain to obtain freshly processed dataset from [seccerts.org](https://seccerts.org). -(FIPS 140) to obtain freshly processed datasets from [seccerts.org](https://seccerts.org). +3. Play with the dataset. See [example notebook](./notebooks/examples/fips.ipynb). +::: +:::: ```{hint} You can work with those with the help of the [common criteria notebook](notebooks/examples/common_criteria.ipynb) or [fips notebook](notebooks/examples/fips.ipynb) and even launch them in MyBinder without installing anything. Just use the 🚀 icon (top-right corner). @@ -20,14 +31,18 @@ You can work with those with the help of the [common criteria notebook](notebook If you insist on processing the whole certificates pipeline, make sure that you installed all [dependencies](installation.md#dependencies). Then, run +::::{tab-set} +:::{tab-item} Common Criteria ```bash -cc-certs all +$ cc-certs all ``` +::: -for Common Criteria processing, or - +:::{tab-item} FIPS 140 ```bash -fips-certs all +$ fips-certs new-run ``` +::: +:::: -for FIPS 140 processing. This script takes a long time to run (few hours) and will create `./cc_dset` or `./fips_dset` directory. To see all options, call the entrypoint with `--help`.
\ No newline at end of file +This script takes a long time to run (few hours) and will create `./cc_dset` or `./fips_dset` directory. To see all options, call the entrypoint with `--help`.
\ No newline at end of file |