From 26783733863f62c468a4c8cb2853badd54e30a39 Mon Sep 17 00:00:00 2001 From: Amlal El Mahrouss Date: Fri, 5 Dec 2025 12:02:43 -0500 Subject: chore: rename README.md Signed-off-by: Amlal El Mahrouss --- README.md | 33 +++++++++++++++++++++++++++++++++ ReadMe.md | 33 --------------------------------- 2 files changed, 33 insertions(+), 33 deletions(-) create mode 100644 README.md delete mode 100644 ReadMe.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0a3eb57 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# NeBuild + +![CI](https://github.com/nekernel-org/nebuild/actions/workflows/c-cpp.yml/badge.svg) +![CI](https://github.com/nekernel-org/nebuild/actions/workflows/c-cpp-dev.yml/badge.svg) +[![License: GPL-3.0](https://img.shields.io/badge/license-BSD--3.0-blue.svg)](LICENSE) + +## Requirements: + +- GNU C++ +- GNU Make + +## Guide (GNU Make): + +- Run make `build-nebuild-core` and `build-nebuild` to build from source. + +## Guide (NeBuild): + +- Run `nebuild` and pass the path to the manifest file to build from source: + +```sh +nebuild targets/osx.json +``` + +## Guide (CMake): + +- Use CMake to build `nebuild` from source: + +```zsh +cmake -S . -B build +cmake --build build +``` + +###### Copyright (C) 2024-2025, Amlal El Mahrouss and NeKernel.org Authors, licensed under the BSD 3 Clause license. diff --git a/ReadMe.md b/ReadMe.md deleted file mode 100644 index 0a3eb57..0000000 --- a/ReadMe.md +++ /dev/null @@ -1,33 +0,0 @@ -# NeBuild - -![CI](https://github.com/nekernel-org/nebuild/actions/workflows/c-cpp.yml/badge.svg) -![CI](https://github.com/nekernel-org/nebuild/actions/workflows/c-cpp-dev.yml/badge.svg) -[![License: GPL-3.0](https://img.shields.io/badge/license-BSD--3.0-blue.svg)](LICENSE) - -## Requirements: - -- GNU C++ -- GNU Make - -## Guide (GNU Make): - -- Run make `build-nebuild-core` and `build-nebuild` to build from source. - -## Guide (NeBuild): - -- Run `nebuild` and pass the path to the manifest file to build from source: - -```sh -nebuild targets/osx.json -``` - -## Guide (CMake): - -- Use CMake to build `nebuild` from source: - -```zsh -cmake -S . -B build -cmake --build build -``` - -###### Copyright (C) 2024-2025, Amlal El Mahrouss and NeKernel.org Authors, licensed under the BSD 3 Clause license. -- cgit v1.2.3