Skip to content

Commit

Permalink
Add book to cheriot.org.
Browse files Browse the repository at this point in the history
  • Loading branch information
davidchisnall committed Nov 7, 2023
1 parent e0bd6be commit 6b84d3d
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 0 deletions.
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ gem "minimal-mistakes-jekyll"
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
gem 'jekyll-scholar'
gem 'jekyll-redirect-from'
end


Expand Down
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ theme: minima
plugins:
- jekyll-feed
- jekyll-scholar
- jekyll-redirect-from

markdown: kramdown
kramdown:
Expand Down
17 changes: 17 additions & 0 deletions _posts/2023-11-06-cheriot-programmers-guide.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
layout: post
title: "CHERIoT Programmers' Guide drafts online"
date: 2023-11-06T15:49+00:00
categories: book guide
---

You might have noticed a link in the header to the [CHERIoT Programmers' Guide](https://cheriot.org/book).
This is an early public draft and will be written in in full view of a live audience of tens (optimistically) of avid readers!

This is using [AsciiDoxy](https://asciidoxy.org), which can parse Doxygen XML and generate AsciiDoc output, to include documentation for the CHERIoT RTOS APIs.
Doxygen, in turn, can use libclang for parsing.
The [book build container](https://github.com/CHERIoT-Platform/book/pkgs/container/book-build-container) contains a version of Doxygen built with the version of libclang from the CHERIoT compiler, which can then recognise the CHERIoT-specific attributes.
This lets it directly reference the RTOS source and should make it easy to update as the code evolves.

Currently, all of the cross references that go between chapters are broken in the HTML version and there are likely to be a lot of other errors (typographical, factual, and grammatical).
This is a live document and will evolve over time, hopefully leading to fewer errors both in absolute numbers and as a proportion of the total text.
4 changes: 4 additions & 0 deletions book.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: The CHERIoT Programmers' Guide
redirect_to: https://cheriot.org/book
---

0 comments on commit 6b84d3d

Please sign in to comment.