Skip to content

Commit

Permalink
Merge pull request #8 from alexmerino13/add-toc-to-readme
Browse files Browse the repository at this point in the history
Added clickable table of contents to ReadMe
  • Loading branch information
decryptofy authored Apr 30, 2024
2 parents 1c7f1f1 + 50c7f5f commit ca05061
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,22 @@ SCARR is a Side-Channel Analysis (SCA) framework written in Python that is optim

SCARR is mainly intended for educational and research purposes. If as an individual you find SCARR useful, please contribute, give us a shout-out, or consider buying us coffee (this project currently runs on coffee only). If you are an organization and you benefit from this development, please consider making an unrestricted gift to the Hardware Security Research Lab at Oregon State University (led by Vincent Immler) to promote SCARR's continued development.

# Table of Contents

* [SCARR Features](#scarr-features)
* [Install](#install)
* [Usage Warning](#usage-warning)
* [Getting Started with SCARR](#getting-started-with-scarr)
* [SCARR's File Format for Side-Channel Analysis Data](#scarrs-file-format-for-side-channel-analysis-data)
* [Working with Other File Formats](#working-with-other-file-formats)
* [Platform Compatibility](#platform-compatibility)
* [Contributing (inbound=outbound)](#contributing-inbound=outbound)
* [License](#license)
* [Authors](#authors)
* [Copyright](#copyright)
* [Citation](#citation)
* [Acknowledgements](#acknowledgements)

# SCARR Features

SCARR is designed to support the following:
Expand Down Expand Up @@ -97,7 +113,7 @@ SCARR was initiated and designed by Vincent Immler out of a necessity to support
Additional contributions by (new contributors, add yourself here):
* Matt Ruff
* Kevin Yuan
* to be added
* Alexander Merino

# Copyright

Expand Down

0 comments on commit ca05061

Please sign in to comment.