summaryrefslogtreecommitdiffhomepage
path: root/ReadMe.md
diff options
context:
space:
mode:
authorAmlal <amlal.elmahrouss@icloud.com>2025-01-24 10:38:36 +0100
committerAmlal <amlal.elmahrouss@icloud.com>2025-01-24 10:38:36 +0100
commit7b4bd3577a31d0f0adc7371840642791ae1567f4 (patch)
tree1a8afc973aaa739d0d763315cad2fd376d1cea9c /ReadMe.md
ADD: Open version, with important changes kept out.
Signed-off-by: Amlal <amlal.elmahrouss@icloud.com>
Diffstat (limited to 'ReadMe.md')
-rw-r--r--ReadMe.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/ReadMe.md b/ReadMe.md
new file mode 100644
index 00000000..7bbdea32
--- /dev/null
+++ b/ReadMe.md
@@ -0,0 +1,29 @@
+<!-- README of NeKernel -->
+
+# New Kernel Architecture (NeKernel)
+
+NeKernel is designed for servers, desktop, mobile and workstations.
+
+## Requirements
+
+- MinGW/GCC for the Kernel, Boot Loader and the LibSCI.
+- Netwide Assembler for the x64 assembly files (in case you're compiling for AMD64).
+
+### Installation
+
+Clone repository:
+
+```
+git clone git@github.com:mediaswirl/nekernel.git
+cd kernel-services
+```
+
+</br>
+
+And then select the makefile (arm64 and amd64 are stable and EFI based) to execute:
+
+```
+make -f amd64-efi.make all
+```
+
+###### Copyright (C) 2024, Amlal EL Mahrouss, all rights reserved. All rights reserved.