From 9e75802dd80021f7433c7fa232134630378ca9cd Mon Sep 17 00:00:00 2001 From: AlviseDeFaveri <elvisilde@gmail.com> Date: Tue, 13 Nov 2018 19:23:32 +0100 Subject: [PATCH] [Readme] Added differences with original repo --- Readme.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/Readme.md b/Readme.md index 29a5e801..1004eb45 100644 --- a/Readme.md +++ b/Readme.md @@ -1,12 +1,34 @@ -# Welcome to the Miosix kernel +# Miosix for Skyward + +This is a fork of the original fedetft/miosix-kernel repo made for Skyward Experimental Rocketry. Every Skyward-related stuff, like new boards or experimental features should be pushed here. + +**IMPORTANT:** when you modify this repo, remember to update the submodule in the repo that includes it. You can find information on how to configure and use the kernel at the following url: http://miosix.org -### Update from original repo -This is a fork of the original fedetft/miosix-kernel repo that was made for the Skyward Experimental Rocketry organisation. +### Main Differences + +A part from additional boards, there are some important differences with the original kernel version: + +1. `miosix/config/Makefile.inc`: The version of the makefile must be `1.07S`, to distinguish this kernel from the official one + +``` +ifneq ($(MAKEFILE_VERSION),1.07S) + $(info You are using an incompatible makefile. Make sure it matches \ + the one distributed with the current version of the kernel) + $(error Error) +endif +``` + +2. `miosix/config/miosix`: The usual `error` is commented out and `JTAG` enabled by default + +Note that these changes must be respected when pulling from the original repo + + +### Pulling from Original Repo If you wish to pull in the changes that were made in the original kernel repo you should: -- GitLab