Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Commit

Permalink
Update README to reflect end of Phase II
Browse files Browse the repository at this point in the history
  • Loading branch information
varunsingh87 committed May 8, 2023
1 parent e3b657b commit dffadc8
Showing 1 changed file with 17 additions and 20 deletions.
37 changes: 17 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
# Frequency Analysis Simulator
**Start Date for Phase I: Monoalphabetic Ciphers**: July 22, 2019

**Start Date for Phase II: Vigenere Ciphers**: September 26, 2022

## Objective
The purpose of this project is to decrypt a monoalphabetic substitution cipher using frequency analysis and find the most optimal algorithm of decrypting a Vigenere cipher.
The purpose of this project is to decrypt a monoalphabetic substitution cipher using frequency analysis and find the optimal algorithm and conditions of decrypting a Vigenere cipher.

## Methods Used
* Frequency Analysis
Expand All @@ -14,12 +10,9 @@ The purpose of this project is to decrypt a monoalphabetic substitution cipher u

## Concepts Used
* Advanced Data Structures - Java Collections API, including TreeSet, HashMap, ArrayList
* Layered Architecture - separated into presentation code (Java Swing framework) and business logic (pure Java)

## Project Description
Frequency Analysis Simulator uses frequency analysis to output a plain text from a ciphertext without receiving the key.
* Layered Architecture - separated into presentation code (Java Swing framework), business logic (pure Java), and data analysis module (pure Java I/O)

## Getting Started
## Usage

1. Clone this repo (for help see the [GitHub documentation](https://help.github.com/articles/cloning-a-repository/)).
2. Run Main.java in the main package of the presentation folder with the following command:
Expand Down Expand Up @@ -47,9 +40,21 @@ outputs/

## Process

### Current (Phase II)

* [Current Data (Phase II)](https://docs.google.com/spreadsheets/d/e/2PACX-1vQIqW8qXtnbI1yTCQR_LcYpy6F7p6eZg5EP07no3c-lBoEkMUbpTPyxo_oa5mCCj7Gfk8LOTonOY-4a/pubhtml)
**Phase I: Monoalphabetic Ciphers**: July 22, 2019 - February 16, 2020

**Phase II: Vigenere Ciphers**: September 26, 2022 - May 8, 2023

### Upcoming - Phase III

- Rewrite of simple substitution cipher (efficient and accurate, no dictionary)
- Visualization of data
- Data collection GUI
- Variants of Vigenere cipher

### Phase II

* [Data from Phase II](https://docs.google.com/spreadsheets/d/e/2PACX-1vQIqW8qXtnbI1yTCQR_LcYpy6F7p6eZg5EP07no3c-lBoEkMUbpTPyxo_oa5mCCj7Gfk8LOTonOY-4a/pubhtml)
* [Presentation](https://docs.google.com/presentation/d/e/2PACX-1vR5Vu_MXCbKyHm0vHaMW5Tn4qaJWVDV34Z_WX1WpHbejcwIzODNiuNKExOOTFTRUUDs7CPsYwz8PA1T/pub?start=false&loop=false&delayms=3000)


Expand All @@ -64,14 +69,6 @@ outputs/
* [Maven] - The dependency management system
* [JUnit] - The testing framework

## Authors

* **Varun Singh** - *Creator* - [varunsingh87](https://github.com/varunsingh87)

## License

Copyright © 2023 Varun Singh

## Sources of Research

* Inspiration from _The Code Book_ by Simon Singh
Expand Down

0 comments on commit dffadc8

Please sign in to comment.