Make README and INSTALL Markdown

This commit is contained in:
Zeckmathederg 2024-05-11 08:59:51 -06:00
parent fc21c8bea3
commit d1e867b7e4
3 changed files with 36 additions and 29 deletions

View File

@ -1,20 +1,20 @@
Ok, so you have downloaded the XML source. Now what? You are probably # Ok, so you have downloaded the XML source. Now what?
wanting to convert these XML files to easier to read HTML.
You are probably wanting to convert these XML files to easier to read HTML.
To install the programs you need to generate html, you need To install the programs you need to generate html, you need
to have or install the following packages: to have or install the following packages:
libxml2 - libxml2
libxslt - libxslt
docbook-xsl-nons-1.79.2 - docbook-xsl-nons-1.79.2
docbook-4.5-dtd - docbook-4.5-dtd
tidy - tidy
Furthermore, you can also generate a PDF file, but need an extra package: Furthermore, you can also generate a PDF file, but need an extra package:
fop (depends on apache-ant which depends on a JDK) - fop (depends on apache-ant which depends on a JDK)
The installation instructions for all these packages are available The installation instructions for all these packages are available
in the BLFS book from one of the mirrors found at in the BLFS book from one of the mirrors found at
https://www.linuxfromscratch.org/blfs. https://www.linuxfromscratch.org/blfs.

20
README
View File

@ -1,20 +0,0 @@
How do I convert these XML files to HTML? You need to have some software
installed that deal with these conversions. Please read the INSTALL file to
determine what programs you need to install and where to get instructions to
install that software.
After that, you can build the html with a simple 'make' command.
The default target builds the html in $(HOME)/public_html/glfs.
For all targets, setting the parameter REV=systemd is needed to build the
systemd version of the book.
Other Makefile targets are: pdf, nochunks, validate, and glfs-patch-list.
pdf: builds GLFS as a PDF file.
nochunks: builds GLFS in one huge file.
validate: does an extensive check for xml errors in the book.
glfs-patch-list: generates a list of all GLFS controlled patches in the book.

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# Gaming Linux From Scatch (GLFS)
Gaming Linux From Scratch is a book that covers how to install packages
like Steam and Wine after the Linux From Scratch book.
# Installation
How do I convert these XML files to HTML? You need to have some software
installed that deal with these conversions. Please read the INSTALL file to
determine what programs you need to install and where to get instructions to
install that software.
After that, you can build the html with a simple **make** command.
The default target builds the html in `$(HOME)/public_html/glfs.`
For all targets, setting the parameter `REV=systemd` is needed to build the
systemd version of the book.
Other Makefile targets are: `pdf`, `nochunks`, `validate`, and `glfs-patch-list`.
`pdf`: builds GLFS as a PDF file.
`nochunks`: builds GLFS in one huge file.
`validate`: does an extensive check for xml errors in the book.
`glfs-patch-list`: generates a list of all GLFS controlled patches in the book.