summaryrefslogtreecommitdiffhomepage
path: root/docs/specs
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-11-29 17:27:19 -0500
committerAmlal El Mahrouss <amlal@nekernel.org>2025-11-29 17:27:19 -0500
commitdad25544802de6d4cd839f5d6d5753ad7faeef97 (patch)
treeac60308829c163689c47da059d5de14296d81f4e /docs/specs
parentbdef578a578177ce95c01fa061a028292556ecbe (diff)
chore: update general specs and citation file, breaking project structure changes as well.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
Diffstat (limited to 'docs/specs')
-rw-r--r--docs/specs/GENERAL_SPECIFICATION.md47
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/specs/GENERAL_SPECIFICATION.md b/docs/specs/GENERAL_SPECIFICATION.md
new file mode 100644
index 0000000..19f787f
--- /dev/null
+++ b/docs/specs/GENERAL_SPECIFICATION.md
@@ -0,0 +1,47 @@
+# 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