mirror of
https://github.com/glfw/glfw.git
synced 2024-11-25 22:14:34 +00:00
Removed legacy documentation.
This commit is contained in:
Camilla Berglund
parent
904db4c605
commit
d0c298de6e
@ -1,57 +0,0 @@
|
|||||||
##########################################################################
|
|
||||||
# Makefile for the GLFW documentation.
|
|
||||||
##########################################################################
|
|
||||||
|
|
||||||
PDFDOCS = glfwrm.pdf glfwug.pdf
|
|
||||||
DVIDOCS = glfwrm.dvi glfwug.dvi
|
|
||||||
|
|
||||||
|
|
||||||
##########################################################################
|
|
||||||
# Build macros
|
|
||||||
##########################################################################
|
|
||||||
default: pdf
|
|
||||||
pdf: $(PDFDOCS)
|
|
||||||
dvi: $(DVIDOCS)
|
|
||||||
|
|
||||||
|
|
||||||
##########################################################################
|
|
||||||
# Clean macros
|
|
||||||
##########################################################################
|
|
||||||
clean:
|
|
||||||
rm -f glfwrm.dvi glfwrm.aux glfwrm.log glfwrm.out glfwrm.pdf glfwrm.toc glfwrm.lot
|
|
||||||
rm -f glfwug.dvi glfwug.aux glfwug.log glfwug.out glfwug.pdf glfwug.toc
|
|
||||||
|
|
||||||
clean-win:
|
|
||||||
@.\\cleanup.bat
|
|
||||||
|
|
||||||
|
|
||||||
##########################################################################
|
|
||||||
# Rules for building the GLFW Reference Manual
|
|
||||||
##########################################################################
|
|
||||||
|
|
||||||
glfwrm.pdf: glfwrm.tex glfwrm.toc glfwrm.lot glfwdoc.sty
|
|
||||||
pdflatex glfwrm.tex
|
|
||||||
|
|
||||||
glfwrm.dvi: glfwrm.tex glfwrm.toc glfwrm.lot glfwdoc.sty
|
|
||||||
latex glfwrm.tex
|
|
||||||
|
|
||||||
glfwrm.toc: glfwrm.tex glfwdoc.sty
|
|
||||||
latex glfwrm.tex
|
|
||||||
|
|
||||||
glfwrm.lot: glfwrm.tex glfwdoc.sty
|
|
||||||
latex glfwrm.tex
|
|
||||||
|
|
||||||
|
|
||||||
##########################################################################
|
|
||||||
# Rules for building the GLFW Users Guide
|
|
||||||
##########################################################################
|
|
||||||
|
|
||||||
glfwug.pdf: glfwug.tex glfwug.toc glfwdoc.sty
|
|
||||||
pdflatex glfwug.tex
|
|
||||||
|
|
||||||
glfwug.dvi: glfwug.tex glfwug.toc glfwdoc.sty
|
|
||||||
latex glfwug.tex
|
|
||||||
|
|
||||||
glfwug.toc: glfwug.tex glfwdoc.sty
|
|
||||||
latex glfwug.tex
|
|
||||||
|
|
||||||
@ -1,22 +0,0 @@
|
|||||||
@echo off
|
|
||||||
|
|
||||||
REM ----------------------------------------------------------------------
|
|
||||||
REM Windows cleanup batch file for the GLFW documentation.
|
|
||||||
REM ----------------------------------------------------------------------
|
|
||||||
|
|
||||||
REM GLFW Reference Manual
|
|
||||||
if exist glfwrm.dvi del glfwrm.dvi
|
|
||||||
if exist glfwrm.aux del glfwrm.aux
|
|
||||||
if exist glfwrm.log del glfwrm.log
|
|
||||||
if exist glfwrm.out del glfwrm.out
|
|
||||||
if exist glfwrm.pdf del glfwrm.pdf
|
|
||||||
if exist glfwrm.toc del glfwrm.toc
|
|
||||||
if exist glfwrm.lot del glfwrm.lot
|
|
||||||
|
|
||||||
REM GLFW Users Guide
|
|
||||||
if exist glfwug.dvi del glfwug.dvi
|
|
||||||
if exist glfwug.aux del glfwug.aux
|
|
||||||
if exist glfwug.log del glfwug.log
|
|
||||||
if exist glfwug.out del glfwug.out
|
|
||||||
if exist glfwug.pdf del glfwug.pdf
|
|
||||||
if exist glfwug.toc del glfwug.toc
|
|
||||||
@ -1,81 +0,0 @@
|
|||||||
%-------------------------------------------------------------------------
|
|
||||||
% Common document formatting and macros for GLFW manuals
|
|
||||||
%-------------------------------------------------------------------------
|
|
||||||
|
|
||||||
% Misc. document info
|
|
||||||
\date{\today}
|
|
||||||
|
|
||||||
% Packages
|
|
||||||
\usepackage{fancyhdr}
|
|
||||||
\usepackage{titling}
|
|
||||||
\usepackage{lastpage}
|
|
||||||
\usepackage{listings}
|
|
||||||
\usepackage{color}
|
|
||||||
\usepackage[overload]{textcase}
|
|
||||||
\usepackage{needspace}
|
|
||||||
\usepackage{times}
|
|
||||||
|
|
||||||
% Logo macros
|
|
||||||
\newcommand{\OpenGL}[1][0]{OpenGL\textsuperscript{\textregistered}}
|
|
||||||
\newcommand{\GLFW}[1][0]{GLFW}
|
|
||||||
|
|
||||||
% Encoding
|
|
||||||
\usepackage[latin1]{inputenc}
|
|
||||||
\usepackage[T1]{fontenc}
|
|
||||||
|
|
||||||
% Page formatting
|
|
||||||
\usepackage[hmargin=2.5cm]{geometry}
|
|
||||||
\raggedright
|
|
||||||
\raggedbottom
|
|
||||||
\sloppy
|
|
||||||
\usepackage{parskip}
|
|
||||||
|
|
||||||
% Header and footer
|
|
||||||
\pagestyle{fancy}
|
|
||||||
%\lhead{\textit{GLFW Reference Manual}}
|
|
||||||
\lhead{\textit{GLFW \glfwdoctype}}
|
|
||||||
\chead{API version \glfwapiver}
|
|
||||||
\rhead{Page \thepage/\pageref{LastPage}}
|
|
||||||
\lfoot{}
|
|
||||||
\cfoot{}
|
|
||||||
\rfoot{}
|
|
||||||
\renewcommand{\headrulewidth}{0.4pt}
|
|
||||||
\renewcommand{\footrulewidth}{0.0pt}
|
|
||||||
|
|
||||||
% Titlepage
|
|
||||||
\newcommand{\glfwmaketitle}{\begin{titlepage}\ \\%
|
|
||||||
\begin{center}%
|
|
||||||
\vspace{7.0cm}{\Huge\textbf{GLFW}}\\%
|
|
||||||
\rule{10.0cm}{0.5pt}\\%
|
|
||||||
\vspace{0.5cm}{\LARGE\textbf{\glfwdoctype}}\\%
|
|
||||||
\vspace{0.8cm}{\large\textbf{API version \glfwapiver}}\\%
|
|
||||||
\textit{\today}\\%
|
|
||||||
\vspace{1.5cm}\textbf{\textcopyright2002-2006 Marcus Geelnard}\\
|
|
||||||
\textbf{\textcopyright2006-2010 Camilla Berglund}\\%
|
|
||||||
\end{center}\end{titlepage}\newpage}
|
|
||||||
|
|
||||||
% Colors
|
|
||||||
\definecolor{code}{rgb}{0.9,0.9,1.0}
|
|
||||||
\definecolor{link}{rgb}{0.6,0.0,0.0}
|
|
||||||
\definecolor{codeA}{rgb}{0.9,1.0,0.9}
|
|
||||||
\definecolor{codeB}{rgb}{1.0,0.9,0.9}
|
|
||||||
|
|
||||||
% Code listings
|
|
||||||
\lstset{frame=single,frameround=tttt,backgroundcolor=\color{code},%
|
|
||||||
language=C,basicstyle={\ttfamily},%
|
|
||||||
breaklines,breakindent=0pt,postbreak=\space\space\space\space}
|
|
||||||
|
|
||||||
|
|
||||||
% A simple hack for keeping lines together
|
|
||||||
\newenvironment{mysamepage}[1][2]{\begin{samepage}\needspace{#1\baselineskip}}{\end{samepage}}
|
|
||||||
|
|
||||||
% Macros for automating function reference entries
|
|
||||||
\newenvironment{refparameters}[1][0]{\begin{mysamepage}\textbf{Parameters}\\}{\end{mysamepage}\bigskip}
|
|
||||||
\newenvironment{refreturn}[1][0]{\begin{mysamepage}\textbf{Return values}\\}{\end{mysamepage}\bigskip}
|
|
||||||
\newenvironment{refdescription}[1][0]{\begin{mysamepage}\textbf{Description}\\}{\end{mysamepage}\bigskip}
|
|
||||||
\newenvironment{refnotes}[1][0]{\begin{mysamepage}\textbf{Notes}\\}{\end{mysamepage}\bigskip}
|
|
||||||
|
|
||||||
% hyperref (bookmarks, links etc) - use this package last
|
|
||||||
\usepackage[colorlinks=true,linkcolor=link,bookmarks=true,bookmarksopen=true,%
|
|
||||||
pdfhighlight=/N,bookmarksnumbered=true,bookmarksopenlevel=1,%
|
|
||||||
pdfview=FitH,pdfstartview=FitH]{hyperref}
|
|
||||||
2364
docs/glfwrm.tex
2364
docs/glfwrm.tex
File diff suppressed because it is too large
Load Diff
1313
docs/glfwug.tex
1313
docs/glfwug.tex
File diff suppressed because it is too large
Load Diff
@ -1,52 +0,0 @@
|
|||||||
Introduction
|
|
||||||
------------
|
|
||||||
|
|
||||||
The GLFW documentation is written in LaTeX. Besides being powerful, LaTeX is
|
|
||||||
also very attractive since all the necessary tools for dealing with LaTeX
|
|
||||||
documentation are both free and ported to a wide variety of platforms. Another
|
|
||||||
advantage is that the LaTeX files are written in plain text, which means that
|
|
||||||
version control systems such as CVS handle them perfectly without having to
|
|
||||||
treat the documents as binary files.
|
|
||||||
|
|
||||||
|
|
||||||
The documents
|
|
||||||
-------------
|
|
||||||
|
|
||||||
There are two main documents:
|
|
||||||
|
|
||||||
glfwrm.tex - The GLFW Reference Manual
|
|
||||||
glfwug.tex - The GLFW Users Guide
|
|
||||||
|
|
||||||
In addition, there is a common LaTeX style file that sets up things
|
|
||||||
such as page formatting and useful macros:
|
|
||||||
|
|
||||||
glfwdoc.sty - Common GLFW document styles and macros
|
|
||||||
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
------------
|
|
||||||
|
|
||||||
Of course you need LaTeX installed on your system in order to compile the GLFW
|
|
||||||
documentation. If you are using a Unix-like operating system, then your
|
|
||||||
package system most likely has a version of LaTeX adapted for your system. If
|
|
||||||
not, the easiest way to get a full LaTeX system is to download/get the TeXLive
|
|
||||||
CD from http://www.tug.org/texlive/. It has all the necessary software for
|
|
||||||
Windows, Mac OS X and most popular Unix-like operating systems.
|
|
||||||
|
|
||||||
A number of LaTeX packages have to be installed in order to compile the
|
|
||||||
GLFW documentation successfully:
|
|
||||||
|
|
||||||
color
|
|
||||||
fancyhdr
|
|
||||||
hyperref
|
|
||||||
lastpage
|
|
||||||
listings
|
|
||||||
needspace
|
|
||||||
textcase
|
|
||||||
times
|
|
||||||
titling
|
|
||||||
|
|
||||||
These packages are all available on the TeXLive CD. Just make sure that
|
|
||||||
you have checked all these packages when installing TeXLive, or get them
|
|
||||||
in some other way if you do not have the TeXLive CD.
|
|
||||||
|
|
||||||
Loading…
Reference in New Issue
Block a user