Update readme
This commit is contained in:
Enrico Fraccaroli
@@ -5,24 +5,33 @@
|
||||
[](https://forthebadge.com)
|
||||
|
||||
[](https://github.com/mentos-team/MentOS/actions/workflows/ubuntu.yml)
|
||||
[](https://github.com/mentos-team/MentOS/actions/workflows/macos.yml)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [What is MentOS](#1-what-is-mentos)
|
||||
2. [Implemented features](#2-implemented-features)
|
||||
3. [Prerequisites](#3-prerequisites)
|
||||
4. [Compiling MentOS](#4-compiling-mentos)
|
||||
5. [Generating the EXT2 filesystem](#5-generating-the-ext2-filesystem)
|
||||
6. [Running MentOS](#6-running-mentos)
|
||||
7. [Running MentOS from GRUB](#7-running-mentos-from-grub)
|
||||
8. [Running and adding new programs to MentOS](#8-running-and-adding-new-programs-to-mentos)
|
||||
9. [Kernel logging](#9-kernel-logging)
|
||||
10. [Change the scheduling algorithm](#10-change-the-scheduling-algorithm)
|
||||
11. [Debugging the kernel](#11-debugging-the-kernel)
|
||||
12. [Contributors](#12-contributors)
|
||||
- [MentOS (Mentoring Operating System)](#mentos-mentoring-operating-system)
|
||||
- [Table of Contents](#table-of-contents)
|
||||
- [What is MentOS](#what-is-mentos)
|
||||
- [Implemented features](#implemented-features)
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Generic Prerequisites](#generic-prerequisites)
|
||||
- [Compile](#compile)
|
||||
- [Execute](#execute)
|
||||
- [Debug](#debug)
|
||||
- [installation Prerequisites](#installation-prerequisites)
|
||||
- [Compiling MentOS](#compiling-mentos)
|
||||
- [Generating the EXT2 filesystem](#generating-the-ext2-filesystem)
|
||||
- [Running MentOS](#running-mentos)
|
||||
- [Running MentOS from GRUB](#running-mentos-from-grub)
|
||||
- [Running and adding new programs to MentOS](#running-and-adding-new-programs-to-mentos)
|
||||
- [Create a new program](#create-a-new-program)
|
||||
- [Add the new program to the list of compiled sources](#add-the-new-program-to-the-list-of-compiled-sources)
|
||||
- [Running a program or a test](#running-a-program-or-a-test)
|
||||
- [Kernel logging](#kernel-logging)
|
||||
- [Change the scheduling algorithm](#change-the-scheduling-algorithm)
|
||||
- [Debugging the kernel](#debugging-the-kernel)
|
||||
- [Contributors](#contributors)
|
||||
|
||||
## 1. What is MentOS
|
||||
## What is MentOS
|
||||
|
||||
MentOS (Mentoring Operating System) is an open source educational operating
|
||||
system. The goal of MentOS is to provide a project environment that is realistic
|
||||
@@ -46,7 +55,7 @@ Gualandri.
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 2. Implemented features
|
||||
## Implemented features
|
||||
Follows the list of implemented features:
|
||||
|
||||
**Processes and Events**
|
||||
@@ -91,14 +100,14 @@ I will try to keep it updated...
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 3. Prerequisites
|
||||
## Prerequisites
|
||||
|
||||
MentOS is compatible with the main **unix-based** operating systems. It has been
|
||||
tested with *Ubuntu*, *WSL1*, *WSL2*, and *MacOS*.
|
||||
|
||||
### 3.1. Generic Prerequisites
|
||||
### Generic Prerequisites
|
||||
|
||||
#### 3.1.1. Compile
|
||||
#### Compile
|
||||
|
||||
For compiling the system:
|
||||
|
||||
@@ -115,19 +124,19 @@ Under **MacOS**, for compiling, you have additional dependencies:
|
||||
- i386-elf-binutils
|
||||
- i386-elf-gcc
|
||||
|
||||
#### 3.1.2. Execute
|
||||
#### Execute
|
||||
|
||||
To execute the operating system, you need to install:
|
||||
|
||||
- qemu-system-i386 (or qemu-system-x86)
|
||||
|
||||
#### 3.1.3. Debug
|
||||
#### Debug
|
||||
|
||||
For debugging we suggest using:
|
||||
|
||||
- gdb or cgdb
|
||||
|
||||
### 3.2. installation Prerequisites
|
||||
### installation Prerequisites
|
||||
|
||||
Under **Ubuntu**, you can type the following commands:
|
||||
|
||||
@@ -151,7 +160,7 @@ brew install gdb cgdb #<- for debug only
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 4. Compiling MentOS
|
||||
## Compiling MentOS
|
||||
|
||||
Compile MentOS with:
|
||||
|
||||
@@ -165,7 +174,7 @@ make
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 5. Generating the EXT2 filesystem
|
||||
## Generating the EXT2 filesystem
|
||||
|
||||
Generate the EXT2 filesystem with:
|
||||
|
||||
@@ -176,7 +185,7 @@ you just need to generate the filesystem once. If you change a `program` you nee
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 6. Running MentOS
|
||||
## Running MentOS
|
||||
|
||||
Boot MentOS with qemu:
|
||||
|
||||
@@ -188,7 +197,7 @@ To login, use one of the usernames listed in `files/etc/passwd`.
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 7. Running MentOS from GRUB
|
||||
## Running MentOS from GRUB
|
||||
|
||||
For booting MentOS from GRUB in QEMU we need the following tools:
|
||||
|
||||
@@ -211,11 +220,11 @@ make qemu-grub
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 8. Running and adding new programs to MentOS
|
||||
## Running and adding new programs to MentOS
|
||||
|
||||
This section explains how to add a new program to MentOS, and also how to run programs in mentos. It also explains how to add new tests, which are located in the `programs/tests` folder.
|
||||
|
||||
### 8.1. Create a new program
|
||||
### Create a new program
|
||||
|
||||
Head to the `programs` (or the `programs/tests`) folder. Create and open a new program, for instance a file called `hello_world.c`, with your preferred editor, and add this content to the file:
|
||||
```C
|
||||
@@ -228,7 +237,7 @@ int main(int argc, char *argv[])
|
||||
}
|
||||
```
|
||||
|
||||
### 8.2. Add the new program to the list of compiled sources
|
||||
### Add the new program to the list of compiled sources
|
||||
Now we can add the program to the list of files which are compiled and placed inside MentOS filesystem.
|
||||
The following procedure is the same for both `programs` and `programs/tests`, what changes is which `CMakeLists.txt` file we modify.
|
||||
|
||||
@@ -253,7 +262,7 @@ set(TESTS
|
||||
|
||||
That's it, the `hello_world.c` file will be compiled and will appear inside the `/bin` or `/bin/tests` folder of MentOS.
|
||||
|
||||
### 8.3. Running a program or a test
|
||||
### Running a program or a test
|
||||
Once you login into MentOS, if you placed your source code in `programs`, you can execute the program by simply typing:
|
||||
```bash
|
||||
hello_world
|
||||
@@ -268,7 +277,7 @@ However, the `/bin/tests` folder is not listed in `PATH`, so, if you want to exe
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 9. Kernel logging
|
||||
## Kernel logging
|
||||
The kernel provides ways of printing logging messages *from* inside the kernel code *to* the bash where you executed the `make qemu`.
|
||||
|
||||
These *logging* functions are:
|
||||
@@ -322,7 +331,7 @@ This example sets the `__DEBUG_LEVEL__`, so that all the messages from `INFO` an
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 10. Change the scheduling algorithm
|
||||
## Change the scheduling algorithm
|
||||
|
||||
MentOS supports scheduling algorithms for aperiodic:
|
||||
|
||||
@@ -390,7 +399,7 @@ make qemu
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 11. Debugging the kernel
|
||||
## Debugging the kernel
|
||||
|
||||
If you want to use GDB to debug MentOS, first you need to compile everything:
|
||||
|
||||
@@ -450,7 +459,7 @@ to connect to the running process.
|
||||
|
||||
*[Back to the Table of Contents](#table-of-contents)*
|
||||
|
||||
## 12. Contributors
|
||||
## Contributors
|
||||
|
||||
Project Manager:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user