Skip to content

Commit 74e58ed

Browse files
dboskdbosk
committed
Updates texgen
- Fixes #5: renames options, renames templates - Fixes #3: adds CC and MIT licenses. - Adds NOWEB templates.
1 parent e78f3de commit 74e58ed

File tree

11 files changed

+251
-53
lines changed

11 files changed

+251
-53
lines changed

CONTRIBUTING.template renamed to CONTRIBUTING.md.template

File renamed without changes.

LICENSE.template renamed to LICENSE.CC

File renamed without changes.

‎LICENSE.MIT‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
Copyright <year>, <author>
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of
4+
this software and associated documentation files (the “Software”), to deal in
5+
the Software without restriction, including without limitation the rights to
6+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
7+
of the Software, and to permit persons to whom the Software is furnished to do
8+
so, subject to the following conditions:
9+
10+
The above copyright notice and this permission notice shall be included in all
11+
copies or substantial portions of the Software.
12+
13+
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19+
SOFTWARE.

‎Makefile‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,25 @@ PKG_NAME= texgen
2020
PKG_PREFIX= /usr/local
2121
PKG_INSTALL_DIR-bin= /bin
2222
PKG_INSTALL_DIR-share= /share/texgen
23+
2324
PKG_INSTALL_FILES-bin= texgen
24-
PKG_INSTALL_FILES-share+= CONTRIBUTING.template
25-
PKG_INSTALL_FILES-share+= LICENSE.template
26-
PKG_INSTALL_FILES-share+= README.template
25+
26+
PKG_INSTALL_FILES-share+= README.md.template
27+
PKG_INSTALL_FILES-share+= CONTRIBUTING.md.template
28+
PKG_INSTALL_FILES-share+= LICENSE.CC
29+
PKG_INSTALL_FILES-share+= LICENSE.MIT
30+
PKG_INSTALL_FILES-share+= abstract.tex
2731
PKG_INSTALL_FILES-share+= contents.tex
2832
PKG_INSTALL_FILES-share+= notes.tex
2933
PKG_INSTALL_FILES-share+= preamble.tex
3034
PKG_INSTALL_FILES-share+= slides.tex
35+
PKG_INSTALL_FILES-share+= Makefile.root
36+
PKG_INSTALL_FILES-share+= Makefile.notes
3137
PKG_INSTALL_FILES-share+= Makefile.slides
32-
PKG_INSTALL_FILES-share+= Makefile.studyguide
38+
PKG_INSTALL_FILES-share+= Makefile.guide
39+
PKG_INSTALL_FILES-share+= program.nw
40+
PKG_INSTALL_FILES-share+= Makefile.noweb
41+
3342
PKG_TARBALL= texgen.tar
3443
PKG_TARBALL_FILES= ${PKG_INSTALL_FILES-bin} ${PKG_INSTALL_FILES-share}
3544

Makefile.studyguide renamed to Makefile.guide

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
.PHONY: all
22
all: studyguide.pdf
33

4-
SRC= studyguide.tex
4+
SRC+= studyguide.tex
55
SRC+= ${MODULE_FILES}
66

7-
MODULE_FILES+= XXX-aim.tex XXX-lit.tex XXX.bib
7+
MODULE_FILES+= XXX-abstract.tex XXX.bib
88

9-
XXX-aim.tex: ../modules/XXX/aims.tex
10-
XXX-lit.tex: ../modules/XXX/abstract.tex
9+
XXX-abstract.tex: ../modules/XXX/abstract.tex
1110
XXX.bib: ../modules/XXX/XXX.bib
1211

1312

‎Makefile.instr‎

Lines changed: 0 additions & 13 deletions
This file was deleted.

‎Makefile.noweb‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
.PHONY: all
2+
all: <package>.pdf
3+
4+
<package>.pdf: <package>.tex <package>.bib
5+
<package>.pdf: abstract.tex LICENSE
6+
7+
<package>.tex: <package>.nw
8+
9+
10+
.PHONY:
11+
all: <package>
12+
13+
<package>.py: <package>.nw
14+
<package>: <package>.py
15+
cp $^ $@
16+
chmod +x $@
17+
18+
19+
.PHONY: clean
20+
clean:
21+
${RM} <package> <package>.py <package>.pdf <package>.tex
22+
23+
24+
PKG_NAME-main= <package>
25+
PKG_FILES-main= <package>
26+
PKG_PREFIX-main= /usr/local
27+
PKG_DIR-main= /bin
28+
PKG_TARBALL_FILES-main= ${PKG_FILES-main} Makefile
29+
30+
31+
INCLUDE_MAKEFILES=<submodule_prefix>/makefiles
32+
include ${INCLUDE_MAKEFILES}/tex.mk
33+
include ${INCLUDE_MAKEFILES}/noweb.mk
34+
include ${INCLUDE_MAKEFILES}/package.mk

README.template renamed to README.md.template

File renamed without changes.

‎acknowledgements.tex‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
This code is available under the following license:
2+
\begin{quote}
3+
\input{LICENSE}
4+
\end{quote}

‎program.nw‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
\documentclass[a4paper]{article}
2+
\usepackage{noweb}
3+
% Needed to relax penalty for breaking code chunks across pages, otherwise
4+
% there might be a lot of space following a code chunk.
5+
\def\nwendcode{\endtrivlist \endgroup}
6+
\let\nwdocspar=\smallbreak
7+
8+
\usepackage[hyphens]{url}
9+
\usepackage{hyperref}
10+
\usepackage{authblk}
11+
12+
\input{preamble.tex}
13+
14+
\title{%
15+
<title>
16+
}
17+
\author{%
18+
<author>
19+
}
20+
\affil{%
21+
<affil>
22+
}
23+
24+
\begin{document}
25+
\maketitle
26+
27+
\begin{abstract}
28+
\input{abstract.tex}
29+
\end{abstract}
30+
\clearpage
31+
32+
\tableofcontents
33+
\clearpage
34+
35+
@
36+
\section{Introduction}
37+
38+
\dots
39+
40+
41+
\section*{Acknowledgements}
42+
\input{acknowledgements.tex}
43+
44+
45+
\printbibliography{}
46+
47+
48+
\section{An index of the code blocks}
49+
\nowebchunks
50+
51+
\end{document}

0 commit comments

Comments
 (0)