From daab0529288cda805c1a6c1729398677e5c3e7cf Mon Sep 17 00:00:00 2001 From: demondave Date: Sun, 6 Feb 2022 22:12:26 +0100 Subject: [PATCH] Added README.txt --- README.txt | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 README.txt diff --git a/README.txt b/README.txt new file mode 100644 index 0000000..5575b71 --- /dev/null +++ b/README.txt @@ -0,0 +1,47 @@ +Hallo Peer-Reviewende, + +In dieser Text-Datei stellen wir unser Projekt erstmal grundlegend vor. +Wir haben beschlossen unsere Website "The Adversary" zu nennen. "The Adversary" ist Englisch +und lässt sich mit "Der Widersacher" übersetzen. Auf unserer Website planen wir Artikel über Themen +die uns interessieren zu veröffentlichen, wie unter anderem Open-Source Projekte, Programmieren +und weitere Sachen die uns interessieren. Wir haben uns jedoch keinen festen Themenrahmen gesetzt. + +Wir haben für unsere Webseite ein Front- sowie Backend, das sich in diesem Ordner befindet. + +Falls du unter Windows bist haben wir dir das Backend in kompilierter Form beigelegt, weil wir +die mit Compilation einhergehenden Probleme ersparen wollten. Jedoch kannst du auch das Backend selber +kompilieren. Folgende Programme werden für das kompilieren benötigt: + +go (Programmiersprache mit der das Backend programmiert wurde) +gcc (Einige Go Module haben benötigen C Code der kompiliert werden muss) + +Wir haben unsere Website auch schon gehostet. +Diese ist unter https://bytedream.org/theadversary/ erreichbar. + +Falls du Hilfe benötigst kannst du dich jederzeit an + +demondave#1483 (Über Discord) +davidmaul5@gmail.com (Über E-Mail) + +wenden. + +Websitenstruktur: + +Wenn du auf die Website gehst siehst du eine Liste mit Artikeln, momentan gibt es nur wenige Artikel, +jedoch haben wir einen Artikel grob vorbereitet. Dieser Artikel sollte "Beispielartikel" heißen, +oben in dem Artikel ist ein Canvas eingebettet, das die Mandelbrot-Menge (https://de.wikipedia.org/wiki/Mandelbrot-Menge) +zeigt diese wird in Echtzeit im Browser mithilfe von WebAssembly (https://de.wikipedia.org/wiki/WebAssembly) +gerendert. Der dahinterliegende Code ist in Rust (https://de.wikipedia.org/wiki/Rust_(Programmiersprache)) +geschrieben. Des weiteren entält unsere Website ein Suchfeld um Artikel zu suchen. + +Ordnerstruktur: + +MandelbrotWASM: + MandelbrotWASM enthält den Source Code für den Mandelbrot Renderer. + +backend: + Der backend Ordner enthält den Source Code für das Backend + +frontend: + Der frontend Ordner enhält den Source Code für das frontend +