diff --git a/BUILD.md b/BUILD.md index dcf6545..9842a6e 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,15 +1,33 @@ -# Dependencies +# SatNOGS Optical Unofficial Guide Build +The document is written in LaTeX which generates a final PDF for +viewing or printing. -* Requires LaTeX. -* Minted syntax highlighting requires python-pygments to be installed. +# Install + +* Requires LaTeX. Note, LaTeX is in the `texlive` packages in Debian + and is relatively huge (1 gig+ install). + +* Minted syntax highlighting requires python3-pygments to be installed. + +* Requires more packages than just below. XXX + +Install dependencies in Debian: ``` -apt install texlive-latex-recommended texlive-xetex \ +sudo apt update +sudo apt install texlive-latex-recommended texlive-xetex \ texlive-humanities texlive-pstricks \ python3-pygments \ fonts-gemunu-libre fonts-linuxlibertine \ - biber + biber git +``` + +Get source code: + +``` +git clone https://spacecruft.org/spacecruft/SNOUG +cd SNOUG/ ``` @@ -26,3 +44,101 @@ To clean: make clean ``` + +# View +View thusly: + +``` +evince SNOUG.pdf +``` + + +# Book Parts +The book source has many features in the LaTeX code. +It includes all parts generally used in non-fiction books. +Unused parts can be easily disabled. + +## Front Matter +* Half Title. +* Frontispiece. +* Title page. +* Copyright page. +* Dedication. +* Epigraph. +* Table of Contents. +* List of Figures. +* List of Tables. +* Foreward. +* Preface. +* Acknowledgements. +* Introduction. +* Prologue. + +## Body Matter +* Chapters. +* Sections. +* Subsections. +* Subsubsections... + +## Back Matter +* Appendix. +* Glossary. +* Bibliography. +* Index. +* Colophon. + +# Features +Features in the LaTeX code. + +* Makefile for ``easy'' LaTeX processing. +* Auto-generated Table of Contents, List of Figures, Index, etc. +* Syntax highlighting of computer source code. +* BibLaTeX bibliographic system using external `kbibtex` application for managing + entries. +* Footnotes. +* Glossary and acronym processing. +* ``Crown Quarto/Crown 4vo'' size (7.44 x 9.68", 18.90 x 24.58cm) in use at + large printing houses (e.g. Lulu/Lightning Source). +* Microtyping with OTF fonts. +* Internal hyperlinks from Table of Contents. +* Internal hyperlinks to footnotes. +* Internal hyperlinks to glossary. +* Internel hyperlinks from index. +* External hyperlinks from references and other URLs. +* Generated ISBN bar code on Half Title page. +* Generated date stamp on Copyright page. +* Use of roman in front matter then arabic page numerals for the body. +* Generation of graphics, diagrams, flow charts, etc., within document. +* Custom colors. +* Custom fonts. +* Custom page style. +* Custom chapter style. +* Unicode UTF-8 (entirely?). +* PDF titling. +* Figures. +* Tables. +* Lists. +* Graphics. +* Labels. +* Internal citations. +* External citations. + + +# Commercial Printing +Book is formatted for publishing at large printing houses (or basements). +HOWTO: set up and print with Lulu. + + +# License +SatNOGS Optical Unofficial Guide + +by Jeff Moe + +Copyright © 2022, Jeff Moe + +Permission is granted to copy, distribute and/or modify this document under +the terms of the Creative Commons Attribution 4.0 International Public License +(CC BY-SA 4.0). + +Published by Jeff Moe, Loveland, Colorado, USA. + diff --git a/README.md b/README.md index abe4232..aee7404 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,18 @@ # SatNOGS Optical Unofficial Guide +The latest version of the SatNOGS Optical Unofficial Guide PDF is available +for download in the Releases section of the source code archive: +* https://spacecruft.org/spacecruft/SNOUG/releases + +To build the PDF from the LaTeX source code, see the `BUILD.md` document. + + +# License SatNOGS Optical Unofficial Guide by Jeff Moe -Copyright 2022, Jeff Moe +Copyright © 2022, Jeff Moe Permission is granted to copy, distribute and/or modify this document under the terms of the Creative Commons Attribution 4.0 International Public License