2
1
Fork 0
mirror of https://git.savannah.gnu.org/git/gnuboot.git synced 2025-01-04 15:27:39 +01:00
gnuboot/website/pages/docs/index.md
Denis 'GNUtoo' Carikli 08b9e449e9
Add a minimal GNU Boot manual.
Currently GNU Boot has no manual, and it needs one to organize better
the information it provides to users and/or contributors.

Since we need to start somewhere, beside adding the manual license, we
describe a bit what the GNU Boot project is, and also ask for help for
completing the manual.

The GFDL 1.3 comes from the gnulib source code at the commit
d64d66cc4897d605f543257dcd038524a0a55215 ("autoupdate").

The beginning and the end of the document are also very similar to the
GNU Hello manual from the commit
24225d705684322f482135e8a2d679485fce0811 ("maint: remove the obsolete
gettext module") as they were copied and modified from that.

The 'dircategory Kernel' was chosen to be the same than GRUB, so they
both appear in the same group in the Emacs info reader ('info'
command in Emacs).

As for the "Overview" of GNU Boot it also contains background
information that will be needed later on and that needs to be
introduced right from the start:

- If people reading the manual do not understand what a boot software
  is, all the rest will be too complicated to explain.

- We also need to explain where GNU Boot is physically located on the
  computer from the start as we plan not to use the 'ROM' terminology
  as it's confusing: ROM means read-only-memory, and so there is no
  point of providing GNU Boot ROM images if the nonfree boot software
  can't be replaced.

Signed-off-by: Denis 'GNUtoo' Carikli <GNUtoo@cyberdimension.org>
Acked-by: Adrien Bourmault <neox@gnu.org>
2024-11-25 16:39:16 +01:00

50 lines
1.5 KiB
Markdown

---
title: Documentation
...
Manuals
=======
The GNU Boot project started creating a manual
([online](../manual/gnuboot.html), [pdf](../manual/gnuboot.pdf)) to
better organize the documentation about GNU Boot. It also enables to
target a wider diversity of users, contributors and maintainers.
Note that the online manual can also be saved locally. In that case
it's a good idea to also save the
[SOIC-16.jpeg](../manual/images/SOIC-16.jpeg) picture in the same directory
to make the image(s) work.
General information
===================
- Information about where to find GNU Boot news, including release
announcements, can be found in the [news page](../news.md).
- [Answers to Frequently Asked Questions about GNU Boot](../faq.md).
Installing and updating GNU Boot
================================
- [What systems can I use GNU Boot on?](hardware/)
- [How to install GNU Boot](install/)
- [How do I know what version I'm running?](install/version.md)
Documentation related to operating systems
==========================================
- [GNU+Linux Guides](gnulinux/)
- [How to install BSD on a libreboot system](bsd/)
Information for developers
==========================
- [How to compile the GNU Boot source code](build/)
- [GNU Boot source code history and provenance](history/)
- [Depthcharge payload](depthcharge/) (**Libreboot 20160907 only**)
- [GRUB payload](grub/)
Other information
=================
- [Miscellaneous](misc/)
- [List of codenames](misc/codenames.md)