Setup

Setting up Cryptographon

Just Learning? Binaries or online

In time all of the code and apps will run online, or there will be binaries that can be downloaded from the project Releases page for your machine (Linux, Windows, even MacOS)

Right now you can go to Trinket.io and run cipher-one and cipher-two

The best way to do this is to use releases - you don't really want the code, you just want to use the code, right?

Please be patient, though please, the site is new and not fully bedded in yet.

Full instructions for use will be in the docs page, that is just a holding page, but will expand out in time.

For coding

Repository

If you want to really play with Cryptographon fork the repo and hack away!

First up fork this repository:

• Create your own Github account (if you don't have one already)
• Go to https://github.com/avastmick/cryptographon
• Top right of the page, click 'Fork' and it will create a version of the repository under your account

Now clone your new repo locally

Copy the URL and on your machine run:

git clone <YOUR-URL>

Contributing? CI, Code Coverage and formatting

The project requires:

• Greater than 90% code coverage - the code must have unit tests that cover 90% of the code, or more
• Each language (Python and Rust) is formatted according to language standards:
  • For Python, run yapf:
    • python -m yapf --recursive cipher-one cipher-two -i
  • For Rust, run rustfmt:
    • cargo fmt --all
• All tests must pass

You need to set up accounts on: This is going to change, see TODO

• CircleCI
• CodeCov.io

To run the tests and see if you have retained the code coverage >95% you need to change the CodeCov.io token in the .circleci/config.yml

When you've set up your Codecov.io account and linked your Fork of Cryptographon you will be provided a new token, paste it in, replacing the upstream value that is there.