Skip to content

Commit 015387b

Browse files
committed
add more personal comments to readme
1 parent 494870b commit 015387b

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

Readme.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,18 @@ Note that while it may compile on older versions of macOS, this library is only
1010

1111
Hi! This is [nmggithub](https://github.com/nmggithub), the sole developer of this project. I tend to avoid using pronouns in general when it comes to documentation, but I realized I couldn't really avoid it here, so this section is going to be a lot more personal than any of the other documentation. Perhaps I may change my style in the future, but for now this is going to stand out, so I thought I'd address it.
1212

13-
Anyway, this library is currently, as of writing on version 3.0.0. After months of work and multiple refactors, it's here. Kass 3.0.0 is a major upgrade from Kass 2.0.0, hence the major version change. But even now, it's still a library in transition. Hopefully not in the architecture department, but Kass 3.0.0 is still missing several features I wish I could have included.
13+
Kass 3.0.0 was a major upgrade from Kass 2.0.0, hence the major version change. But even now, it's still a library in transition. Hopefully not in the architecture department, but Kass 3.0.0 was still missing several features I wish I could have included.
1414

15-
Going forward, I want to try and stick with [Semantic Versioning](https://semver.org/), but I don't think I can commit to that fully (especially with how often my mind changes). I honestly don't know how many (if anyone) is using this project, but I want 3.0 onward to be at least somewhat stable.
15+
Going forward, I want to try and stick with [Semantic Versioning](https://semver.org/), but I don't think I can commit to that fully (especially with how often my mind changes). I honestly don't know how many (if anyone) is using this project, but I wanted 3.0 onward to be at least somewhat stable.
1616

1717
I consider the `MachCore` module to be mostly stable, so there will likely be little changes to it going forward (save for the addition of virtual memory API's). `BSDCore` is in its early stages, so a lot can change there. Finally, `Linking` will likely be folded into `BSDCore` at some point.
1818

1919
I hope this library is of some use to you, and I look forward to more stable releases in the future. If you have any issues with it, feel free to [file an issue.](https://github.com/nmggithub/Kass/issues) If you'd like to contribute, go ahead and [open a PR.](https://github.com/nmggithub/Kass/pulls) I appreciate all the feedback and support.
2020

21+
### Kass 4.0.0 update
22+
23+
As of writing, Kass 4.0.0 has been released. Everything I have said above still stands. I will try to stick with SemVer, but I can't promise anything. There's still some API's I'd love to add more stability to, and more I'd like to add. The XNU kernel is a big project, and and I keep finding more and more interesting corners of it. Anyway, onward I go!
24+
2125
## On Licenses
2226

2327
Most of this code is MIT-licensed. However, there are some cases where substance is copied from header files licensed under [Apple's Public Source License](https://opensource.apple.com/apsl/) and other licenses. Where deemed appropriate, copyright notices for the relevant licenses are included. Please see the source code for more information.

0 commit comments

Comments
 (0)