first commit

README.md

@@ -0,0 +1,49 @@
+# chexed
+
+A simple terminal-based hex editor. It is written in C and uses the ncurses library.
+
+## Prerequisites
+
+You need a Linux system and the ncurses library.
+
+Install it on Debian/Ubuntu with this command:
+```bash
+sudo apt install libncurses-dev
+```
+
+## Compilation
+
+Use `gcc` to compile the source code. Run this command:
+
+```bash
+gcc chexed.c -o chexed -lncurses
+```
+
+## Usage
+
+Run the program with a file path:
+
+```bash
+./chexed your_file.bin
+```
+
+### Controls
+
+* **Arrow Keys**: navigate through the file.
+* **Page Up / Page Down**: scroll quickly.
+* **0-9, A-F**: input hex values.
+* **+ / -**: increment or decrement the byte value by 1.
+* **Ctrl+S**: save changes to the file.
+* **Ctrl+Q**: quit the program.
+
+## Known Limitations
+
+The program loads the entire file into RAM. Do not open files larger than your available memory.
+
+The file size is fixed: you cannot insert or delete bytes.
+
+Editing works in a specific way: typing a new digit shifts the current value 4 bits to the left.
+
+## License
+
+MIT