Merge pull request #14 from Voxi0/main

feat: updated limine to latest version, prettier readme, moved website for emexos to this repo and got rid of a bunch of compiler warnings

Author: emexos

.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+indent_style = tab
+trim_trailing_whitespaces = true
+insert_final_newline = false
+charset = utf-8
+
+[*.nix]
+indent_size = 2
+
+[*.{c,h,ld}]
+indent_size = 4

.github/workflows/deploy.yml

@@ -0,0 +1,54 @@
+name: Deploy website
+
+# Set permissions of the `GITHUB_TOKEN` to allow deployment to Github Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# Workflow triggers
+on:
+  # Whenever any changes are made to `web/` from either a push or merging a pull request
+  push:
+    paths:
+      - "web/**"
+  pull_request:
+    paths:
+      - "web/**"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Workflow actions
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      # Clone repository
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      # Configure Github Pages
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      # Upload build - In this case it's just static files e.g. HTML and CSS
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload specific directory
+          path: './web'
+
+      # Deploy to Github Pages
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

Makefile

@@ -15,12 +15,13 @@ all: $(ISO)
 fetchDeps:
 	@echo "[DEPS] Fetching dependencies/libraries"
 	@mkdir -p $(INCLUDE_DIR)
-	#@mkdir -p $(BUILD_DIR)/src/kernel/console/functions
+
 	@echo "[DEPS] Fetching Limine"
-	@rm -rf $(INCLUDE_DIR)/limine
-	@git clone https://codeberg.org/Limine/Limine.git --branch=v10.3.0-binary --depth=1 $(INCLUDE_DIR)/limine
-	@echo "[DEPS] Building limine binary"
-	@$(MAKE) -C $(INCLUDE_DIR)/limine
+	@rm -rf $(LIMINE_DIR)
+	@git clone https://codeberg.org/Limine/Limine.git --branch=v10.x-binary --depth=1 $(LIMINE_DIR)
+	@rm -rf $(LIMINE_DIR)/.git
+	@echo "[DEPS] Fetching Limine protocol header file"
+	@wget https://codeberg.org/Limine/limine-protocol/raw/branch/trunk/include/limine.h -O $(LIMINE_DIR)/limine.h
 
 disk:
 	@mkdir -p $(DISK_DIR)
@@ -34,12 +35,12 @@ $(BUILD_DIR)/kernel.elf: src/kernel/linker.ld $(OBJS)
 userspace:
 	@$(MAKE) -C src/userspace
 
-# Ensure host limine tool exists (Linux/macOS binary).
+# Compile Limine
 $(LIMINE_TOOL):
 	@$(MAKE) -C $(LIMINE_DIR)
 
 # Create bootable ISO
-$(ISO): limine.conf $(BUILD_DIR)/kernel.elf disk userspace $(LIMINE_TOOL)
+$(ISO): limine.conf $(LIMINE_TOOL) $(BUILD_DIR)/kernel.elf disk userspace
 	@echo "[ISO] Creating bootable image..."
 	@rm -rf $(ISODIR)
 	@rm -f $(DISK_DIR)/initrd.cpio
@@ -76,7 +77,6 @@ $(ISO): limine.conf $(BUILD_DIR)/kernel.elf disk userspace $(LIMINE_TOOL)
 	./tools/initrd.sh
 	@cp $(DISK_DIR)/initrd.cpio $(ISODIR)/boot/
 
-
 	@xorriso -as mkisofs -b boot/limine/limine-bios-cd.bin \
 		-no-emul-boot -boot-load-size 4 -boot-info-table \
 		--efi-boot boot/limine/limine-uefi-cd.bin \
@@ -119,4 +119,4 @@ $(BUILD_DIR)/%.asm.o: %.asm
 clean:
 	@echo "[CLR] Cleaning..."
 	@rm -rf $(BUILD_DIR)
-	@echo "[OK]"
+	@echo "[OK]"

README.md

@@ -1,8 +1,13 @@
-# emexOS - a simple 64 Bit OS written in C
-
 <div align="center">
-  <img src="./screenshots/screen_size1.png" width="50%">
-  <img src="./screenshots/login.png" width="50%">
+	<h1>emexOS</h1>
+	<h5>a simple 64-bit os written in c</h5>
+
+![Discord Badge](https://img.shields.io/badge/Join%20the%20Discord-Black?style=for-the-badge&logo=discord&logoColor=white&color=black)
+
+![GitHub License](https://img.shields.io/github/license/emexos/emexOS1?style=for-the-badge&label=License&labelColor=black&color=white)
+![GitHub repo size](https://img.shields.io/github/repo-size/emexos/emexOS1?style=for-the-badge&label=size&labelColor=black&color=white)
+![GitHub Repo stars](https://img.shields.io/github/stars/emexos/emexos1?style=for-the-badge&labelColor=black&color=white)
+
 </div>
 
 ## Build Dependencies
@@ -11,46 +16,45 @@ For building and compiling emexOS, ensure you have the following installed,
 - [NASM](https://www.nasm.us/) - Assembler.
 - [QEMU](https://www.qemu.org/) - Our preferred emulator.
 - [Xorriso](https://www.gnu.org/software/xorriso/) - ISO creation.
-- [Git](https://git-scm.com/) - To fetch dependencies.
+- [Git](https://git-scm.com/) and [wget](https://www.gnu.org/software/wget/) - To fetch dependencies.
 
-You can use Zig instead of x86_64-gcc if you prefer to,
-- [Zig](https://ziglang.org/) - Zig lets you build the whole OS using just one command.
+You can use [Zig](https://ziglang.org/) instead of GCC if you prefer to.
 
 ## For Nix Users
-If you’re using [Nix](https://nixos.org/), you can run the provided flake that installs all the build dependencies. That way, you can set up a complete emexOS development environment with a single, simple command.
+Ensure you have flakes enabled first and then run `nix develop` to enter the provided development shell which will have all build dependencies and such installed for you. I'd recommend updating the flake using `nix flake update` as it's sometimes not updated for long periods of time.
 
 ## Building and Compiling
-Now that you have all the required build dependencies installed, you can finally build and run emexOS.
+With all build dependencies installed, you can finally build and run emexOS.
+> [!CAUTION]
+> If booting emexOS on real hardware, ensure your device has no existing data or else emexOS **WILL DELETE IT WITHOUT ASKING**
 
 **Using gnu-make**
-- `make fetchDeps` - Fetches all libraries and such that emexOS depends on. Obviously `git` is used for this operation.
-- `make` - Builds emexOS.
-- `make run` - Emulates emexOS using QEMU.
-- `make clean` - Cleans up all build outputs.
+- `make fetchDeps` - Fetch all libraries and such that emexOS depends on e.g. Limine. `git` and `wget` are used for this.
+- `make` - Build emexOS.
+- `make run` - Emulate emexOS using QEMU.
+- `make clean` - Clean up all build outputs.
 
 **Using Zig**
 - `zig build` - Fetch, build and run.
 - `zig build -Dnofetch` - Build and run.
 - `zig build -Dclean` - Remove (cache, output), fetch, build and run.
 - `zig build -Dnofetch -Dclean` - Remove (cache, output), build and run.
 
-## Running 
-to run emexOS on QEMU use `make run` 
-on real hardware make sure your device does not have any existing data on the disk, emexOS will delete it without asking! (soon there will be a menu which asks you)
-
 ## Console
-After the bootup emexOS will ask you about a password to login. the password is "emex", but you can change that in shared/config/user.h
+After booting, you will be asked for a password which is "emex" by default, to log in. The password can be changed in `shared/config/user.h`.
 
-currently there is no smp support btw so if you run emexOS just use one core
+Currently, no SMP support is available just yet so emexOS runs using only a single core.
 
----
-
-## License:
-- GNU GPLv3
-- Attribution required (see ATTRIBUTION.md)
+<div align="center">
+	<h2>Contributors</h2>
+	<a href="https://github.com/emexos/emexOS1/graphs/contributors">
+	  <img src="https://contrib.rocks/image?repo=emexos/emexOS1" />
+	</a>
+	<p>Made with [contrib.rocks](https://contrib.rocks).</p>
+</div>
 
+---
 
-## Writer
- - README.md by Voxi0 & emexSW & Bi Moz
- - emexOS project started by emexSW
-##
+<div align="center">
+	<p><bold>emexOS - by emexSW</bold></p>
+</div>

common.mk

@@ -15,8 +15,8 @@ VLD  = @echo "[LD]  $@" && $(LD)
 # Compiler Flags
 COMMON_FLAGS += -I $(INCLUDE_DIR) -I $(SRC_DIR) -I shared/ -ffreestanding -fno-stack-protector -fno-lto \
                 -fno-PIE -fno-pic -m64 -march=x86-64 -mno-80387 -mno-mmx \
-                -mno-sse -mno-sse2 -mno-red-zone -mcmodel=kernel -Wall -Wextra
-CFLAGS ?= $(COMMON_FLAGS) -std=gnu11
+                -mno-sse -mno-sse2 -mno-red-zone -mcmodel=kernel -Wall -Wextra -Wpedantic
+CFLAGS ?= $(COMMON_FLAGS) -std=c23
 CXXFLAGS ?= $(COMMON_FLAGS) -std=c++17 -fno-exceptions -fno-rtti
 LDFLAGS ?= -nostdlib -static -no-pie -z text -z max-page-size=0x1000
 ASFLAGS ?= -f elf64
@@ -32,4 +32,4 @@ DISK_DIR := dsk
 DISK_IMG := $(DISK_DIR)/disk.img
 INCLUDE_DIR := include
 ISODIR := $(BUILD_DIR)/isodir
-ISO := $(BUILD_DIR)/$(OS_NAME).iso
+ISO := $(BUILD_DIR)/$(OS_NAME).iso

docs/Building emexOS from source

@@ -11,4 +11,4 @@ The easiest way to run emexOS is to run it in QEMU.
 - Choose either to enable storage or not to.
 - Keep the default options and select "finish".
 
-Learn how to install QEMU in [Arch](https://github.com/BloopBiMoz/emexOS1/blob/main/docs/QEMU_Arch.md) and [Debian](https://github.com/BloopBiMoz/emexOS1/blob/main/docs/QEMU_Debian.md) based distributions.
+Learn how to install QEMU in [Arch](./QEMU_Arch.md) and [Debian](./QEMU_Debian.md) based distributions.