summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-03-28 15:28:59 +0200
committerManuel Pégourié-Gonnard <mpg@elzevir.fr>2010-03-28 15:28:59 +0200
commit1f6833806d0c5fe6926efb4d3f2387651040a80c (patch)
tree4f5b96954f9dffd7deed9a815dd8b6b33721d673
parent0bb6d1e8d28f914398d3b3de15cf5317f480d02a (diff)
downloadlualibs-1f6833806d0c5fe6926efb4d3f2387651040a80c.tar.gz
Add README, News and Makefile.
-rw-r--r--Makefile93
-rw-r--r--News9
-rw-r--r--README65
3 files changed, 167 insertions, 0 deletions
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..6ebf497
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,93 @@
+# Makefile for luaextra.
+
+NAME = luaextra
+DTX = $(wildcard *.dtx)
+DOC_DTX = $(patsubst %.dtx, %.pdf, $(DTX))
+EXTRA = $(wildcard luaextra-*.lua)
+
+# Files grouped by generation mode
+UNPACKED= luaextra.lua
+COMPILED = $(DOC_DTX)
+GENERATED = $(UNPACKED) $(DOC_DTX)
+SOURCE = $(DTX) $(EXTRA) README Makefile News
+
+# Files grouped by installation location
+RUNFILES = $(UNPACKED) $(EXTRA)
+DOCFILES = $(DOC_DTX) README News
+SRCFILES = $(DTX) $(SRC_TEX) Makefile
+
+# The following definitions should be equivalent
+# ALL_FILES = $(RUNFILES) $(DOCFILES) $(SRCFILES)
+ALL_FILES = $(GENERATED) $(SOURCE)
+
+# Installation locations
+FORMAT = luatex
+RUNDIR = $(TEXMFROOT)/tex/$(FORMAT)/$(NAME)
+DOCDIR = $(TEXMFROOT)/doc/$(FORMAT)/$(NAME)
+SRCDIR = $(TEXMFROOT)/source/$(FORMAT)/$(NAME)
+TEXMFROOT = ./texmf
+
+CTAN_ZIP = $(NAME).zip
+TDS_ZIP = $(NAME).tds.zip
+ZIPS = $(CTAN_ZIP) $(TDS_ZIP)
+
+DO_TEX = tex --interaction=batchmode $< >/dev/null
+DO_PDFLATEX = pdflatex --interaction=batchmode $< >/dev/null
+DO_PDFLUALATEX = pdflualatex --interaction=batchmode $< >/dev/null
+DO_MAKEINDEX = makeindex -s gind.ist $(subst .dtx,,$<) >/dev/null 2>&1
+
+all: $(GENERATED) $(DOC_TEX)
+doc: $(COMPILED)
+unpack: $(UNPACKED)
+ctan: $(CTAN_ZIP)
+tds: $(TDS_ZIP)
+world: all ctan
+.PHONY: all doc unpack ctan tds world
+
+%.pdf: %.dtx
+ $(DO_PDFLATEX)
+ $(DO_MAKEINDEX)
+ $(DO_PDFLATEX)
+ $(DO_PDFLATEX)
+
+$(UNPACKED): luaextra.dtx
+ $(DO_TEX)
+
+$(CTAN_ZIP): $(SOURCE) $(COMPILED) $(TDS_ZIP)
+ @echo "Making $@ for CTAN upload."
+ @$(RM) -- $@
+ @zip -9 $@ $^ >/dev/null
+
+define run-install
+@mkdir -p $(RUNDIR) && cp $(RUNFILES) $(RUNDIR)
+@mkdir -p $(DOCDIR) && cp $(DOCFILES) $(DOCDIR)
+@mkdir -p $(SRCDIR) && cp $(SRCFILES) $(SRCDIR)
+endef
+
+$(TDS_ZIP): TEXMFROOT=./tmp-texmf
+$(TDS_ZIP): $(ALL_FILES)
+ @echo "Making TDS-ready archive $@."
+ @$(RM) -- $@
+ $(run-install)
+ @cd $(TEXMFROOT) && zip -9 ../$@ -r . >/dev/null
+ @$(RM) -r -- $(TEXMFROOT)
+
+.PHONY: install manifest clean mrproper
+
+install: $(ALL_FILES)
+ @echo "Installing in '$(TEXMFROOT)'."
+ $(run-install)
+
+manifest:
+ @echo "Source files:"
+ @for f in $(SOURCE); do echo $$f; done
+ @echo ""
+ @echo "Derived files:"
+ @for f in $(GENERATED); do echo $$f; done
+
+clean:
+ @$(RM) -- *.log *.aux *.toc *.idx *.ind *.ilg
+
+mrproper: clean
+ @$(RM) -- $(GENERATED) $(ZIPS)
+
diff --git a/News b/News
new file mode 100644
index 0000000..a6cad74
--- /dev/null
+++ b/News
@@ -0,0 +1,9 @@
+ History of the luaextra package
+
+2010/03/28
+ * now a separate package (previously part of the luatextra bundle)
+
+2010/01/10 v0.92
+ * making the file loadable without luatextra (useful for lua scripts)
+ * fixing typo in localize_sep
+
diff --git a/README b/README
new file mode 100644
index 0000000..460e03c
--- /dev/null
+++ b/README
@@ -0,0 +1,65 @@
+ The luaextra generic package
+
+
+Luaextra is a collection of Lua modules useful for general programming.
+
+Installation
+------------
+
+Here are the recommended installation methods (preferred first).
+The methods "commented out" are currently not available.
+
+% 1. If you are using TeX Live 2008 or later, use 'tlmgr install luatextra'.
+% Alternatively, try your (TeX or Linux) distribution's package management system.
+%
+% 2. a. Grab luatextra.tds.zip on CTAN.
+% b. Unzip it at the root of one or your TDS trees.
+% c. You may need to update some filename database after this, see your TeX
+% distribution's manual for details.
+
+3. a. Grab the sources from CTAN or github.
+ b. Run 'make install TEXMFROOT=/path/to/texmf'.
+ c. See 2c.
+
+Manifest
+--------
+
+Source files:
+ luaextra.dtx
+ luaextra-aux.lua
+ luaextra-boolean.lua
+ luaextra-dimen.lua
+ luaextra-dir.lua
+ luaextra-file.lua
+ luaextra-io.lua
+ luaextra-lpeg.lua
+ luaextra-math.lua
+ luaextra-md5.lua
+ luaextra-number.lua
+ luaextra-os.lua
+ luaextra-set.lua
+ luaextra-string.lua
+ luaextra-table.lua
+ luaextra-unicode.lua
+ luaextra-url.lua
+ luaextra-utils.lua
+ README
+ Makefile
+ News
+
+Derived files:
+ luaextra.lua
+ luaextra.pdf
+
+License
+-------
+
+This work and the derived files are under the Creative Commons CC0 license.
+
+See the full text at
+
+http://creativecommons.org/publicdomain/zero/1.0/legalcode
+
+and a FAQ at
+
+http://wiki.creativecommons.org/CC0