Skip to content

Instantly share code, notes, and snippets.

@lucasgruwez
Created January 24, 2018 11:45
Show Gist options
  • Save lucasgruwez/33c60585b5c896b7cc6adc00a005fab6 to your computer and use it in GitHub Desktop.
Save lucasgruwez/33c60585b5c896b7cc6adc00a005fab6 to your computer and use it in GitHub Desktop.
README.md template for CrypTools

Project name

One Paragraph of project description goes here

How it works

Explain how the cipher works in the simplest way posible. Use tables and illustrations if needed. If you need illustrations for the README, please contact the CrypTools owners.

Logic XOR truth table.

A B A Xor B
0 0 0
0 1 1
1 0 1
1 1 0

A code block can also be used to explain how a cipher works.

Input = 01001000 01000101 01011001
Key   = 11001010 11001010 11001010

XOR   = 10000010 10001111 10010011

Implementations

Language Encrypt Decrypt
Javascript encrypt.js decrypt.js
Python encrypt.py decrypt.py

Running the tests

Tests are automatically handled by Travis CI.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment