Skip to content

Commit 0d0eadb

Browse files
Improved the README, added an idea.
1 parent 5c65ff3 commit 0d0eadb

3 files changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
This is the official repository of the LibertyOS kernel. LibertyOS is an operating system, built with Rust, that is open-source, free-to-use, and open to new contributors. Everything in LOS is, or will be, built from scratch. Currently, LOS supports x86_64 systems, and can be booted on real hardware, using a simple bootloader. This operating system is being worked on continuously, and all changes are logged in the VERSIONHISTORY.md file (in the root directory of this repository). If you want to see a more detailed explanation of changes between versions, you can read the commits on the GitHub repository.
44

5+
6+
## How to Contribute
7+
Would you like to help make this kernel even better? We have plenty of things that need to be done, and we could always use help doing them! There is a folder in this repository (called "ideas") which contains different files that explain an idea for the kernel. If you have a new idea, simply create a new file within the ideas folder, submit a pull request, and one of us will merge your idea into the main branch. There are a lot of great features being worked on right now, and we could use as many talented developers as we can get!
8+
9+
510
## Blog
611
As of August 22, 2022, there is a blog file (BLOG.md). This will explain some of the design decisions that are made, some of the issues in development, and what to expect in the near future. LibertyOS is not dead. There is a bright future ahead for this project.
712

VERSIONHISTORY.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@ Version History
22

33
# Version History
44

5+
## 0.17.3
6+
- Added "better-error-messages" (ideas/better-error-messages.md).
7+
- Added a section to the README to explain how people can contribute to the kernel's development (README.md).
8+
59
## 0.17.2
610
- Created the data::parser module (src/data/parse).
711
- Created mod.rs for data::parse (src/data/parse/mod.rs).

ideas/better-error-messages.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Better Error Messages - July 13, 2023 - Daniel Teberian
2+
I was listening to somebody explain how the Rust compiler is far better than any other compiler, and one of the things that Rust's compiler does well with is how it explains errors to people. The kernel has the ability to report errors, but the error messages are not too helpful. Perhaps we could include messages that explain what caused the error, and how the user could fix the error. As of right now, the error messages are virtually impossible for anybody to understand unless they have been actually developing the kernel.
3+
4+
I want to apologize for the mistakes that I have made in developing the kernel. I have done my best to remove the things that really made understanding the kernel even more complicated than necessary, and I am going to continue improving the kernel's documentation, organization, and overall performance. This idea is one that addresses an issue that I created, and I apologize for the way I made the kernel so confusing.

0 commit comments

Comments
 (0)