Skip to content

Commit

Permalink
meta: fixup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tyler569 committed Apr 30, 2024
1 parent 260f2f8 commit 2af8267
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,11 @@ For more specific feature and capability information, see

## Building nightingale

Nightingale uses the CMake build system and defaults to the `clang` compiler.
Nightingale uses the CMake build system, and you can find package
requirements in the GitHub Actions workflow files.

The only uncommon package you will need is the `grub-mkrescue` tool provided by
grub2. This is usually packaged with grub2 or in a 'grub tools' package.

- Execute `./make` in the root of the project.
- To run, use `./run` - its help text will show the available options
- To build, execute `make` in the root of the project.
- To run, use `./run.rb` - its help text will show the available options

## Project map

Expand All @@ -36,13 +34,16 @@ grub2. This is usually packaged with grub2 or in a 'grub tools' package.
- `libc`: Common userland routines, including things like `printf`
- `linker`: Kernel module loader, userland dynamic linker, and `libelf`
- `script`: Utility scripts for building and developing nightingale
- `toolchain`: CMake toolchain files
- `user`: In-tree usermode programs distributed with the system

### Scripts

- `dump.rb`: convenience wrapper around `objdump`
- `run.rb`: convenience wrapper around `qemu-system-x86_64` to set the options I
need
- `bt.bash`: convenience wrapper around `addr2line` for backtracing
- `dump.bash`: convenience wrapper around `objdump`
- `format.bash`: convenience wrapper around `clang-format`
- `make.bash`: core build engine for the project
- `run.rb`: convenience wrapper around `qemu-system-x86_64`

### Interface Manifests

Expand Down
6 changes: 3 additions & 3 deletions kernel/video.c
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ void video() {
fprintf(video_stream, "STREAM - ABCDEFGHIJKLMNOPQRSTUVWXYZ\n");
fprintf(video_stream, "STREAM - `~!@#$%%^&*(){}[]_+-=:;\"'<>,.?/\\\n");

for (int i = 0; i < 128; i++) {
fprintf(video_stream, "STREAM - %c\n", i);
}
// for (int i = 0; i < 128; i++) {
// fprintf(video_stream, "STREAM - %c\n", i);
// }
}
2 changes: 1 addition & 1 deletion run.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
stdio: "serial",
tee: true,
smp: 2,
network: "e1000",
network: nil,
debug_wait: false,
disk_image: "none",
video: false,
Expand Down

0 comments on commit 2af8267

Please sign in to comment.