From 0e3c7097ea746380249b4f2d3acab15bf238d89e Mon Sep 17 00:00:00 2001 From: overcuriousity Date: Mon, 27 Oct 2025 17:55:55 +0100 Subject: [PATCH] update README.md --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd1b296..803fa6d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,44 @@ # fscalc +fscalc ist eine einfache, statische Weboberfläche zur Berechnung von Hex-Offsets innerhalb gängiger Dateisysteme. Das Projekt richtet sich an Entwickler, Forensiker und Systemadministratoren, die schnell Offset-Werte und Adressberechnungen für Dateisystemstrukturen benötigen. + +## Hauptfunktionen + +- Interaktive Berechnung von Hex-Offsets für verschiedene Dateisysteme +- Übersichtliche Anzeige und Export von berechneten Werten +- Integrierte Hilfswerkzeuge und Utilities (z.B. eingebettete CyberChef-Instanz) + +## Voraussetzungen + +- Ein moderner Webbrowser (Chrome, Firefox, Edge) +- Node/Python o.Ä. sind nicht zwingend erforderlich, da die Oberfläche statisch ist. + +## Installation / Lokale Nutzung + +1. Repository klonen oder als ZIP entpacken. +2. Im Projektverzeichnis einen lokalen HTTP-Server starten und `webroot/` als Dokumenten-Root verwenden. + +Beispiel mit Python 3 (im Projektroot ausführen): + +```fish +python3 -m http.server --directory webroot 8000 +``` + +Dann den Browser öffnen und zu `http://localhost:8000/` navigieren. + +Alternativ kann jeder andere statische Server (z. B. `live-server`, `http-server` aus npm) verwendet werden. + +## Projektstruktur (ausgewählte Dateien) + +- `webroot/` – Statische Weboberfläche + - `index.html` – Startseite + - `js/calculator.js` – Kernlogik der Offset-Berechnungen + - `js/main.js` – Initialisierung und UI-Handling + - `js/utils.js` – Hilfsfunktionen + - `cyberchef/` – Eingebettete CyberChef-Instanz + +## Nutzung / Beispiele + +- Öffne die Startseite und wähle das gewünschte Dateisystem bzw. die Berechnungsoption. +- Gib die Ausgangsadresse/den Sektor und die benötigten Parameter ein. +- Die berechneten Hex-Offsets werden sofort berechnet und lassen sich kopieren oder lokal weiterverarbeiten. -Simple Weboberfläche zur Berechnung der jeweiligen Hex-Offsets innerhalb üblicher Dateisysteme \ No newline at end of file