Skip to content

Commit 9693fa3

Browse files
committed
README updated
1 parent 016d308 commit 9693fa3

File tree

7 files changed

+38
-8
lines changed

7 files changed

+38
-8
lines changed

docs/README.md

Lines changed: 38 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,45 @@
1-
# SEOS(Title pending)
1+
<p align="CENTER">
2+
<img src="./assets/dark_l.png#gh-dark-mode-only">
3+
<img src="./assets/light_l.png#gh-light-mode-only">
4+
5+
</p>
6+
<h1 align="CENTER">SectorOS-RE4</h1>
27

3-
A new rewrite of SectorOS_RE2.
8+
<p align="CENTER">
9+
SectorOS-RE4 is a rewrite 4 operating system project, currently in progress. This README file provides important information about the project, including how to build and run it.
10+
Kernel Version
11+
</p>
12+
<hr>
13+
<br>
414

5-
The kernel is currently v2.23.03.6NR
615

7-
## Build
16+
## 🧱 Kernel
17+
The current kernel version for SectorOS-RE4 is v2.23.03.6NR.<br>
818

9-
To build the project, execute `make` command in root directory of the project
19+
## ⚙️ Build Steps
1020

11-
To run the kernel, execute `make run` command in root directory of the project
21+
**To build the project, follow these steps:**
1222

13-
## License
23+
1. Open the command prompt/terminal in the root directory of the project.
24+
2. Type make and press Enter to start the build process.
1425

15-
This project is licensed under the [GNU GPLv3](../COPYING). <img align="right" src="https://www.gnu.org/graphics/gplv3-with-text-136x68.png"></img>
26+
**To run the kernel, follow these steps:**
27+
28+
1. Open the command prompt/terminal in the root directory of the project.
29+
2. Type make run and press Enter to run the kernel.
30+
31+
## 🏆 Contributing
32+
33+
SectorOS-RE4 is an open-source project, and contributions are welcome. To contribute, please follow these steps:
34+
35+
1. Fork the project repository.
36+
2. Make your changes and commit them to your forked repository.
37+
3. Submit a pull request to the main project repository.
38+
39+
## 🛡️ License
40+
41+
This project is licensed under the [GNU GPLv3](../COPYING).
42+
<br><br></img>
43+
<img align="right" src="https://www.gnu.org/graphics/gplv3-with-text-136x68.png"></img>
44+
<img align="left" height="50" src="./assets/dark_xl.png#gh-dark-mode-only">
45+
<img align="left" height="50" src="./assets/light_xl.png#gh-light-mode-only">

docs/assets/dark_l.png

4.12 KB
Loading

docs/assets/dark_s.png

7.44 KB
Loading

docs/assets/dark_xl.png

7.27 KB
Loading

docs/assets/light_l.png

4.18 KB
Loading

docs/assets/light_s.png

3.98 KB
Loading

docs/assets/light_xl.png

7.3 KB
Loading

0 commit comments

Comments
 (0)