Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LaTeX-ify the manual #458

Closed
wants to merge 72 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
72 commits
Select commit Hold shift + click to select a range
69d10ed
Add all images from original Word manual
JesseTG Nov 23, 2015
5266584
Add first draft of LaTeX-revised manual
JesseTG Nov 23, 2015
f329193
Add LaTeX files to .gitignore
JesseTG Nov 23, 2015
f09ccd3
Set graphics path properly
JesseTG Nov 23, 2015
48749fe
Don't color links
JesseTG Nov 27, 2015
e68aa2a
Revise TOC entry for Introduction
JesseTG Nov 27, 2015
4cac1e9
Clean up Introduction
JesseTG Nov 27, 2015
23f238b
Add \glmheader macro
JesseTG Nov 27, 2015
a4e222e
Clean up FAQ
JesseTG Nov 27, 2015
21976f1
Clean up the Code Samples
JesseTG Nov 27, 2015
de57f65
\texttt{} a section
JesseTG Nov 27, 2015
f6d3d40
Tighten up Known Issues
JesseTG Nov 27, 2015
160f6ea
Declare References section
JesseTG Nov 27, 2015
7343d1d
Clean up Acknowledgements and Quotes from the web
JesseTG Nov 27, 2015
17c854c
Clean up Official GLM Resources
JesseTG Nov 27, 2015
27076fc
Clean up OpenGL Specifications
JesseTG Nov 27, 2015
cdf6df3
Remove External Links
JesseTG Nov 27, 2015
4c1f937
More or less clean up Projects Using GLM
JesseTG Nov 27, 2015
fce058f
Clean up Tutorials section
JesseTG Nov 27, 2015
1ea0d10
Clean up Alternatives section
JesseTG Nov 27, 2015
7772129
More Acknowledgement cleanups
JesseTG Nov 27, 2015
911e17e
Clean up Setup subsection
JesseTG Nov 27, 2015
5528955
Clean up Faster Compilation subsection
JesseTG Nov 27, 2015
a6eda35
Clean up Dependencies subsection
JesseTG Nov 27, 2015
e789f62
Clean up the Swizzle Operators section
JesseTG Nov 27, 2015
4a64bb7
Clean up Default Precision subsection
JesseTG Nov 27, 2015
6c0655b
Don't promise compiler messages that don't necessarily exist
JesseTG Nov 27, 2015
bfbd8d8
C++ standards
JesseTG Nov 27, 2015
bfc4fa7
Clean up SIMD Support subsection
JesseTG Nov 27, 2015
4cebf2e
Clean up Compile-Time Type Info
JesseTG Nov 27, 2015
934d4fd
Clean up disabling default initialization
JesseTG Nov 27, 2015
af44852
Clean up some language in the GTC extension descriptions
JesseTG Nov 27, 2015
27da84b
Clean up OpenGL Interoperability
JesseTG Nov 27, 2015
b3d4859
Remove all \iffalse
JesseTG Nov 27, 2015
a610d10
Rename doc.tex to glm.tex
JesseTG Nov 27, 2015
a8dffb2
Remove glm.docx and glm.pdf
JesseTG Nov 27, 2015
b7e3c1b
Add UseLATEX.cmake
JesseTG Nov 27, 2015
092dc05
Add an option to build the GLM manual
JesseTG Dec 3, 2015
6732e7e
Add a bit to the .gitignore
JesseTG Dec 3, 2015
52a9b88
Add some commands that specify e-mails or GL headers
JesseTG Dec 3, 2015
1322857
Clean up language in introduction
JesseTG Dec 3, 2015
9d61136
Finish clean up Swizzling text
JesseTG Dec 3, 2015
2e20b7b
Finish cleaning up the Preprocessor Options section
JesseTG Dec 3, 2015
e78e560
Finish cleaning up the extensions section
JesseTG Dec 3, 2015
777986c
Finish cleaning up the Known Issues section
JesseTG Dec 3, 2015
36d7fd8
Finish cleaning up the FAQ section
JesseTG Dec 3, 2015
0e83e2e
Finish cleaning up the last few sections
JesseTG Dec 3, 2015
ef9be77
Add the second duck photo and the GLM logo
JesseTG Dec 3, 2015
8675201
Add cmake/FindPythonModule.cmake
JesseTG Dec 6, 2015
bef13d4
Look for Python if trying to build the manual
JesseTG Dec 6, 2015
56164d0
Find pygments with the script I just added
JesseTG Dec 6, 2015
5cd68ad
the
JesseTG Dec 6, 2015
bdd0689
Use \newpage{} properly to indicate end of a section
JesseTG Dec 6, 2015
1161054
Clarify a few statements
JesseTG Dec 6, 2015
4e28ea8
Add in a section about the static constants
JesseTG Dec 6, 2015
125c3bd
Fix typos in Known Issues
JesseTG Dec 6, 2015
ea91a4d
Qualify some vec uses
JesseTG Dec 6, 2015
8f0bcb5
Merge the two Triangle Normal flavors into one code sample
JesseTG Dec 6, 2015
0033f0b
Clean up the rest of the code samples
JesseTG Dec 6, 2015
b542041
Clarify the manual building requirements a bit
JesseTG Dec 8, 2015
b2bc8cd
Add a section on building the manual to README.md
JesseTG Dec 8, 2015
3751456
Clarify package management
JesseTG Dec 8, 2015
0bb5ebe
Oops, lmodern isn't in CTAN
JesseTG Dec 8, 2015
bd165c4
Find another quoting library that MikTeX provides
JesseTG Feb 9, 2016
7c7c421
Add a directory to .gitignore
JesseTG Feb 9, 2016
32cf081
Fix a a typo
JesseTG Feb 9, 2016
fd1980e
Update copyright year
JesseTG Feb 20, 2016
ce537b8
Add some newlines
JesseTG Feb 20, 2016
e6f368b
Update stable release to 0.9.7.2
JesseTG Feb 20, 2016
234a3eb
Shorten a sentence
JesseTG Feb 20, 2016
ae39d90
Fix a typo
JesseTG Feb 20, 2016
ef3ee87
Merge branch 'master' of https://github.com/g-truc/glm into jtg/latex…
JesseTG Mar 19, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,5 +46,17 @@ Makefile
*.cbp
*.user

# Documentation
*.cpt
*.aux
*.toc
*.fls
*.fdb_latexmk
*.pyg
*.pdf
doc/doc/*
doc/_minted*
# ^ All files are copied to a directory when compiling the manual; don't wanna commit these!

# Misc.
*.log
15 changes: 15 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,21 @@ enable_testing()

add_definitions(-D_CRT_SECURE_NO_WARNINGS)

option(GLM_BUILD_MANUAL_ENABLE "Build GLM manual (requires LaTeX, Python, and Pygments)" OFF)
if(GLM_BUILD_MANUAL_ENABLE)
set(LATEX_OUTPUT_PATH "doc") # Where the pdf will ultimately be spit out

include(UseLATEX) # For compiling the manual
find_package(PythonInterp REQUIRED) # For LaTeX's minted package, needed for source highlighting
include(FindPythonModule) # For minted, which uses pygments
find_python_module(pygments REQUIRED)

if(LATEX_COMPILER AND PYTHONINTERP_FOUND AND PY_PYGMENTS)
add_latex_document("doc/glm.tex" TARGET_NAME manual)
message(STATUS "To build the GLM manual by itself, rather than as part of the default target, run the 'manual' target")
endif()
endif()

option(GLM_STATIC_LIBRARY_ENABLE "GLM static library" OFF)
if(GLM_STATIC_LIBRARY_ENABLE)
message(STATUS "GLM is a header only library, no need to build it. Set the option GLM_STATIC_LIBRARY_ENABLE with ON to build an optional static library")
Expand Down
25 changes: 25 additions & 0 deletions cmake/FindPythonModule.cmake
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Find if a Python module is installed
# Found at http://www.cmake.org/pipermail/cmake/2011-January/041666.html
# To use do: find_python_module(PyQt4 REQUIRED)
function(find_python_module module)
string(TOUPPER ${module} module_upper)
if(NOT PY_${module_upper})
if(ARGC GREATER 1 AND ARGV1 STREQUAL "REQUIRED")
set(${module}_FIND_REQUIRED TRUE)
endif()
# A module's location is usually a directory, but for binary modules
# it's a .so file.
execute_process(COMMAND "${PYTHON_EXECUTABLE}" "-c"
"import re, ${module}; print(re.compile('/__init__.py.*').sub('',${module}.__file__))"
RESULT_VARIABLE _${module}_status
OUTPUT_VARIABLE _${module}_location
ERROR_QUIET
OUTPUT_STRIP_TRAILING_WHITESPACE)
if(NOT _${module}_status)
set(PY_${module_upper} ${_${module}_location} CACHE STRING
"Location of Python module ${module}")
endif(NOT _${module}_status)
endif(NOT PY_${module_upper})
find_package_handle_standard_args(PY_${module} DEFAULT_MSG PY_${module_upper})
endfunction(find_python_module)

Loading