summaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-12-28 09:23:52 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2025-12-28 09:24:04 +0100
commit4ed27545ece2dc084508cc0aca288fa866ae1879 (patch)
treed4503af6fa34c0e9ac9319790c933aef7c1ae32b /docs
parent7259a73084bfb3295154857a052c0354f79fb93d (diff)
feat! rename docs to doc.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'docs')
-rw-r--r--docs/.keep0
-rw-r--r--docs/drawio/COMPILERKIT_DESIGN.drawio64
-rw-r--r--docs/drawio/DEBUGGERKIT_DESIGN.drawio47
-rw-r--r--docs/specs/GENERAL_SPECIFICATION.md47
-rw-r--r--docs/tex/.keep0
5 files changed, 0 insertions, 158 deletions
diff --git a/docs/.keep b/docs/.keep
deleted file mode 100644
index e69de29..0000000
--- a/docs/.keep
+++ /dev/null
diff --git a/docs/drawio/COMPILERKIT_DESIGN.drawio b/docs/drawio/COMPILERKIT_DESIGN.drawio
deleted file mode 100644
index 78934b6..0000000
--- a/docs/drawio/COMPILERKIT_DESIGN.drawio
+++ /dev/null
@@ -1,64 +0,0 @@
-<mxfile host="65bd71144e">
- <diagram id="Hvu3NLRsK3fSdSTnrkoh" name="Page-1">
- <mxGraphModel dx="960" dy="709" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
- <root>
- <mxCell id="0"/>
- <mxCell id="1" parent="0"/>
- <mxCell id="4" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="2" target="3" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="2" value="Frontend" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
- <mxGeometry x="130" y="580" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="6" style="edgeStyle=none;html=1;" parent="1" source="3" target="5" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="3" value="Compiler Stage 1&lt;div&gt;(Assembler)&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
- <mxGeometry x="285" y="580" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="8" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="5" target="7" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="5" value="Compiler Stage 2&lt;div&gt;(AE encoding)&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
- <mxGeometry x="440" y="580" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="7" value="64-bit Linker Driver" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
- <mxGeometry x="600" y="580" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="10" style="edgeStyle=none;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" parent="1" source="9" target="2" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="14" style="edgeStyle=none;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="9" target="11" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="9" value="Cl Driver Tool" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
- <mxGeometry x="130" y="410" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="12" style="edgeStyle=none;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" parent="1" source="11" target="7" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="13" style="edgeStyle=none;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" parent="1" source="11" target="9" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="11" value="Linker Tool" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
- <mxGeometry x="600" y="410" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="15" value="High Level CLI" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
- <mxGeometry x="130" y="290" width="590" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="17" style="edgeStyle=none;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.102;entryY=1;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="9" target="15" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="18" style="edgeStyle=none;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.898;entryY=1.05;entryDx=0;entryDy=0;entryPerimeter=0;" parent="1" source="11" target="15" edge="1">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="19" value="CompilerKit Architecture" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
- <mxGeometry x="338" y="210" width="175" height="30" as="geometry"/>
- </mxCell>
- <mxCell id="20" value="CompilerKit.so" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" parent="1" vertex="1">
- <mxGeometry x="338" y="510" width="175" height="30" as="geometry"/>
- </mxCell>
- </root>
- </mxGraphModel>
- </diagram>
-</mxfile> \ No newline at end of file
diff --git a/docs/drawio/DEBUGGERKIT_DESIGN.drawio b/docs/drawio/DEBUGGERKIT_DESIGN.drawio
deleted file mode 100644
index 158e4ba..0000000
--- a/docs/drawio/DEBUGGERKIT_DESIGN.drawio
+++ /dev/null
@@ -1,47 +0,0 @@
-<mxfile host="65bd71144e">
- <diagram id="rBoUEB_FcKsNnY3-oVdp" name="Page-1">
- <mxGraphModel dx="822" dy="556" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
- <root>
- <mxCell id="0"/>
- <mxCell id="1" parent="0"/>
- <mxCell id="5" style="edgeStyle=none;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" target="4">
- <mxGeometry relative="1" as="geometry">
- <mxPoint x="410" y="180" as="sourcePoint"/>
- </mxGeometry>
- </mxCell>
- <mxCell id="6" style="edgeStyle=none;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="2" target="3">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="2" value="LD Contract" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
- <mxGeometry x="350" y="120" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="12" style="edgeStyle=none;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="3" target="11">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="3" value="LD Contract&lt;div&gt;(A)&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
- <mxGeometry x="280" y="230" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="10" style="edgeStyle=none;html=1;" edge="1" parent="1" source="4" target="8">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="4" value="LD Contract&lt;div&gt;(B)&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
- <mxGeometry x="440" y="230" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="9" style="edgeStyle=none;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;" edge="1" parent="1" source="8" target="4">
- <mxGeometry relative="1" as="geometry"/>
- </mxCell>
- <mxCell id="8" value="EntryT of B" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
- <mxGeometry x="620" y="230" width="120" height="60" as="geometry"/>
- </mxCell>
- <mxCell id="13" style="edgeStyle=none;html=1;" edge="1" parent="1" source="11">
- <mxGeometry relative="1" as="geometry">
- <mxPoint x="340" y="290" as="targetPoint"/>
- </mxGeometry>
- </mxCell>
- <mxCell id="11" value="EntryT of A" style="rounded=0;whiteSpace=wrap;html=1;" vertex="1" parent="1">
- <mxGeometry x="280" y="330" width="120" height="60" as="geometry"/>
- </mxCell>
- </root>
- </mxGraphModel>
- </diagram>
-</mxfile> \ No newline at end of file
diff --git a/docs/specs/GENERAL_SPECIFICATION.md b/docs/specs/GENERAL_SPECIFICATION.md
deleted file mode 100644
index 19f787f..0000000
--- a/docs/specs/GENERAL_SPECIFICATION.md
+++ /dev/null
@@ -1,47 +0,0 @@
-# Specification of CompilerKit
-
-===================================
-
-# 0: General Information
-
-===================================
-
-- Output format: PEF
-- Object format: AE
-- Used Languages: Assembly, and C++
-
-===================================
-
-# 1: CompilerKit
-
-===================================
-
-- Shall support compilation, assembling and linking.
-- Shall be written in C++
-- Shall support the assembler too.
-- Shall provide primitives for compilers, assemblers and linkers.
-- Shall support multiple architectures.
-- Shall be easy to expand and maintain.
-
-===================================
-
-# 2: LibC++
-
-===================================
-
-- Shall support C++ runtime and ABI for NeKernel.
-- Shall support a basic subset of the C++ library.
-- Shall be written in C++
-
-
-===================================
-
-# 3: DebuggerKit
-
-===================================
-
-- Shall be written in C++
-- Shall have a debugger.
-- Shall support multiple architectures.
-- Shall have a kernel deubgger.
-- Shall be easy to expand and maintain. \ No newline at end of file
diff --git a/docs/tex/.keep b/docs/tex/.keep
deleted file mode 100644
index e69de29..0000000
--- a/docs/tex/.keep
+++ /dev/null