summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAmlal El Mahrouss <amlal@nekernel.org>2025-11-19 01:35:47 +0100
committerAmlal El Mahrouss <amlal@nekernel.org>2025-11-19 01:35:47 +0100
commit36bd2efdc56877729617ccf5222911484fb86d31 (patch)
tree45529dd53bc260dae713bc64e374b8b5c00619cb
parentfd6cf0d19715d79dee3d067a3d6b498e517904d1 (diff)
feat: new README and CI.
Signed-off-by: Amlal El Mahrouss <amlal@nekernel.org>
-rw-r--r--.github/workflows/system-ci.yml22
-rw-r--r--README.md12
-rw-r--r--meta/readme-logo.pngbin0 -> 887313 bytes
-rw-r--r--sbin/install.cc6
4 files changed, 31 insertions, 9 deletions
diff --git a/.github/workflows/system-ci.yml b/.github/workflows/system-ci.yml
new file mode 100644
index 0000000..3027a43
--- /dev/null
+++ b/.github/workflows/system-ci.yml
@@ -0,0 +1,22 @@
+name: System CI
+
+on:
+ push:
+ branches: [ "stable" ]
+ pull_request:
+ branches: [ "stable" ]
+
+jobs:
+ build:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v4
+ - name: Install Packages
+ run: sudo apt-get install libboost-all-dev
+ - name: Build SuperNE
+ run: |
+ cd sbin
+ mkdir build
+ cd build \ No newline at end of file
diff --git a/README.md b/README.md
index 83a725b..4a3d41d 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,13 @@
-# The SuperNE
+<img src="./meta/readme-logo.png"/>
## Brief
-A centralized repository designed to hold the NeKernel.org projects together.
+A centralized repository made to hold the NeKernel components together. Acting as the software distribution for NeKernel.
## Why?
-Mainly for three reasons:
-
-- Holds the codebase in a single repository, it is way more maintable than a fragmented one.
-- Easier paths based on the `superne` path, i.e (../kernel -> /superne/dev/kernel)
-- One superne release is easier than releasing each component on its own.
+- Hold the codebase in a single repository, it is way more maintable than a fragmented one.
+- Easier paths based on the `system` path, i.e (../kernel -> /system/dev/nekernel)
+- One system release is easier than releasing each component on its own.
###### Copyright 2025 - Amlal El Mahrouss & NeKernel.org Contributors. Licensed under Apache 2.0.
diff --git a/meta/readme-logo.png b/meta/readme-logo.png
new file mode 100644
index 0000000..b7ec578
--- /dev/null
+++ b/meta/readme-logo.png
Binary files differ
diff --git a/sbin/install.cc b/sbin/install.cc
index cb9115b..4bdb4fa 100644
--- a/sbin/install.cc
+++ b/sbin/install.cc
@@ -8,9 +8,11 @@ Copyright (C) 2025, Amlal El Mahrouss, licensed under the Apache 2.0 license.
int main(int argc, char** argv)
{
- ocl::io::print("install: installing target system...\n");
+ ocl::io::print("install: Installing distribution...\n");
/// AMLALE: TODO: implement the install logic here.
+
+ ocl::io::print("install: Done!\n");
- return 0;
+ return EXIT_SUCCESS;
} \ No newline at end of file