From 9f9e87553f9547a0451abf4f5b36f8b64d688a6f Mon Sep 17 00:00:00 2001
From: DevDoggo <devdoggo@protonmail.com>
Date: Tue, 8 May 2018 18:06:38 +0200
Subject: [PATCH] Updated README.md

---
 README.md | 32 +++++++++++++++++++-------------
 1 file changed, 19 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index cb99f10..30cee1e 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,28 @@
-# `cortex-m-quickstart`
+# Decryptor for the Cortex-M 
+## Requirements
+STM32F401 Nucleo-64
+Rust
 
-> A template for building applications for ARM Cortex-M microcontrollers
+## Description
+This is code made to be run ontop of a microcontroller. 
+It uses a seed to decrypt an encrypted string of input. 
 
-# [Documentation](https://docs.rs/cortex-m-quickstart)
+## How to use
+There are three .sh scripts ready to be used.
 
-# License
+compile.sh
 
-Licensed under either of
+> Builds using cargo onto the target thumbv7em-none-eabihf in --release mode
+
+openocd.sh
+
+> Runs the code on the target
+
+gdb.sh
+
+> Runs gdb and connects to the target's code
 
-- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
-  http://www.apache.org/licenses/LICENSE-2.0)
 
-- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
 
-at your option.
 
-## Contribution
 
-Unless you explicitly state otherwise, any contribution intentionally submitted
-for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
-dual licensed as above, without any additional terms or conditions.
-- 
GitLab