Update README.md

diff --git a/README.md b/README.md
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..fbabe61e18993461c500ece3ccac6f20038b4e7d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,25 @@
+# EEPROM programmer
+This program is designed for the ST Nucleo board F401-RE, and will be able to flash and dump the ROM of a SST39SF040
+
+## How to use this
+1. Compile with `make`
+2. Flash with `st-flash write build/EEPROM_programmer.bin 0x8000000`
+3. Listen to output with `minicom -D /dev/ttyACM0 -b 115200`
+
+## License
+```
+    Nucleo EEPROM programmer
+    Copyright (C) 2025  Ayabusa
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, version 3 of the License.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program.  If not, see https://www.gnu.org/licenses/gpl-3.0.html.
+```
\ No newline at end of file