Skip to content

Commit

Permalink
Update references to repository
Browse files Browse the repository at this point in the history
* Rename references to `littleosbook-src` to `littleosbook`.
* Update README.md to add information about building and dependencies
  • Loading branch information
OrdoFlammae committed Sep 23, 2024
1 parent 1a1b4a7 commit 21ec111
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 4 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# littleosbook-src
# littleosbook

This is the source code for the book "The little book about OS development".
This is the source code for the book ["The little book about OS development (OrdoFlammae's Fork)"](https://ordoflammae.github.io/littleosbook/).
The source for the book is written in
["Pandoc"](http://pandoc.org) Markdown.

## Building
This is a fork by `OrdoFlammae` to keep the book maintained, as the original version needed a number of fixes to keep it up to date. The goal is to expand the material to fit newer innovations in the field of OS development, without abandoning the original spirit of the material.

## Dependencies
If you want to use the build scripts (which we recommend you to do), you need
["Make"](http://www.gnu.org/software/make/).

Expand All @@ -14,6 +16,24 @@ installing Pandoc, see <http://pandoc.org/installing.html>.

If you want to create the PDF version, you also need `pdflatex` installed.

### Ubuntu

For Ubuntu, the following command can be executed to install all dependencies:

```bash
sudo apt-get install -y pandoc pandoc-citeproc texlive-latex-base texlive-latex-extra texlive-fonts-recommended texlive-fonts-extra
```

## Building

The entire system can be built via

```bash
make all
```

The resulting files can be found in the `public` directory.

## Errors
If you find any error (there are probably plenty :)), please open a new
["issue"](https://github.com/OrdoFlammae/littleosbook-src/issues).
Expand Down
2 changes: 1 addition & 1 deletion template.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h2 class="author">$author$</h2>
$endfor$
</div>
<div class="subheader">
<a href="https://github.com/OrdoFlammae/littleosbook-src/">GitHub Repository</a>
<a href="https://github.com/OrdoFlammae/littleosbook/">GitHub Repository</a>
<a class="pdflink" href="book.pdf" title="PDF version">PDF version</a>
</div>
<div id='content'>
Expand Down

0 comments on commit 21ec111

Please sign in to comment.