From d1e867b7e4fbcd6a4ada37c4c466b9f8163696e7 Mon Sep 17 00:00:00 2001 From: Zeckmathederg Date: Sat, 11 May 2024 08:59:51 -0600 Subject: [PATCH] Make README and INSTALL Markdown --- INSTALL => INSTALL.md | 18 +++++++++--------- README | 20 -------------------- README.md | 27 +++++++++++++++++++++++++++ 3 files changed, 36 insertions(+), 29 deletions(-) rename INSTALL => INSTALL.md (57%) delete mode 100644 README create mode 100644 README.md diff --git a/INSTALL b/INSTALL.md similarity index 57% rename from INSTALL rename to INSTALL.md index a803571d44..de77f40974 100644 --- a/INSTALL +++ b/INSTALL.md @@ -1,20 +1,20 @@ -Ok, so you have downloaded the XML source. Now what? You are probably -wanting to convert these XML files to easier to read HTML. +# Ok, so you have downloaded the XML source. Now what? + +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 have or install the following packages: -libxml2 -libxslt -docbook-xsl-nons-1.79.2 -docbook-4.5-dtd -tidy +- libxml2 +- libxslt +- docbook-xsl-nons-1.79.2 +- docbook-4.5-dtd +- tidy 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 in the BLFS book from one of the mirrors found at https://www.linuxfromscratch.org/blfs. - diff --git a/README b/README deleted file mode 100644 index 7765faaea5..0000000000 --- a/README +++ /dev/null @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000000..ef544c52a6 --- /dev/null +++ b/README.md @@ -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.