justin/jsix_import
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

[docs] README update

Browse Source 
Long overdue update to the README about the project in general as well
as updating build instructions.
This commit is contained in:
Justin C. Miller
2021-01-20 18:31:32 -08:00
parent 0ae2f935af
commit 521df1f4b7
1 changed files with 13 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,7 +1,7 @@
# jsix: A toy OS kernel # jsix: A hobby operating system
**jsix** is the kernel for the hobby OS that I am currently building. It's **jsix** is the hobby operating system that I am currently building. It's far
far from finished, or even being usable. Instead, it's a sandbox for me to play from finished, or even being usable. Instead, it's a sandbox for me to play
with kernel-level code and explore architectures. with kernel-level code and explore architectures.
The design goals of the project are: The design goals of the project are:
@@ -9,7 +9,8 @@ The design goals of the project are:
* Modernity - I'm not interested in designing for legacy systems, or running on * Modernity - I'm not interested in designing for legacy systems, or running on
all hardware out there. My target is only 64 bit architecutres, and modern all hardware out there. My target is only 64 bit architecutres, and modern
commodity hardware. Currently that means x64 systems with Nehalem or newer commodity hardware. Currently that means x64 systems with Nehalem or newer
CPUs and UEFI firmware. Eventually I'd like to work on an AArch64 port, CPUs and UEFI firmware. (See [this list][cpu_features] for the currently
required CPU features.) Eventually I'd like to work on an AArch64 port,
partly to force myself to factor out the architecture-dependent pieces of the partly to force myself to factor out the architecture-dependent pieces of the
code base. code base.
@@ -17,8 +18,7 @@ The design goals of the project are:
processes as possible, in the microkernel fashion. A sub-goal of this is to processes as possible, in the microkernel fashion. A sub-goal of this is to
explore where the bottlenecks of such a microkernel are now, and whether explore where the bottlenecks of such a microkernel are now, and whether
eschewing legacy hardware will let me design a system that's less bogged down eschewing legacy hardware will let me design a system that's less bogged down
by the traditional microkernel problems. Given that there are no processes by the traditional microkernel problems.
yet, the kernel is monolithic by default.
* Exploration - I'm really mostly doing this to have fun learning and exploring * Exploration - I'm really mostly doing this to have fun learning and exploring
modern OS development. Modular design may be tossed out (hopefully modern OS development. Modular design may be tossed out (hopefully
@@ -31,6 +31,8 @@ name, started around the same time as this project. So I've renamed this kernel
jsix (Always styled _jsix_ or `j6`, never capitalized) as an homage to L4, xv6, jsix (Always styled _jsix_ or `j6`, never capitalized) as an homage to L4, xv6,
and my wonderful wife. and my wonderful wife.
[cpu_features]: https://github.com/justinian/jsix/blob/master/src/libraries/cpu/include/cpu/features.inc
## Building ## Building
jsix uses the [Ninja][] build tool, and generates the build files for it with a jsix uses the [Ninja][] build tool, and generates the build files for it with a
@@ -38,7 +40,7 @@ custom tool called [Bonnibel][]. Bonnibel can be installed with [Cargo][], or
downloaded as a prebuilt binary from its Github repository. downloaded as a prebuilt binary from its Github repository.
[Ninja]: https://ninja-build.org [Ninja]: https://ninja-build.org
[Bonnibel]: https://github.com/justinian/bonnibel [Bonnibel]: https://github.com/justinian/bonnibel_rs
[Cargo]: https://crates.io/crates/bonnibel [Cargo]: https://crates.io/crates/bonnibel
Requrirements: Requrirements:
@@ -71,8 +73,8 @@ I personally run this either from a real debian amd64 testing/buster machine or
a windows WSL debian testing/buster installation. The following should be a windows WSL debian testing/buster installation. The following should be
enough to set up such a system to build the kernel: enough to set up such a system to build the kernel:
sudo apt install qemu-system-x86 nasm clang-6.0 mtools curl sudo apt install qemu-system-x86 nasm clang-10 mtools curl ninja-build
sudo update-alternatives /usr/bin/clang clang /usr/bin/clang-6.0 1000 sudo update-alternatives /usr/bin/clang clang /usr/bin/clang-10 1000
sudo update-alternatives /usr/bin/clang++ clang++ /usr/bin/clang++-6.0 1000 sudo update-alternatives /usr/bin/clang++ clang++ /usr/bin/clang++-10 1000
curl -L -o pb https://github.com/justinian/bonnibel/releases/download/2.0.0/pb_linux_amd64 && chmod a+x pb curl -L -o pb https://github.com/justinian/bonnibel_rs/releases/download/v2.3.0/pb-linux-amd64 && chmod a+x pb