summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/lua2dox/INSTALL
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/lua2dox/INSTALL')
-rw-r--r--Master/texmf-dist/doc/support/lua2dox/INSTALL42
1 files changed, 42 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/lua2dox/INSTALL b/Master/texmf-dist/doc/support/lua2dox/INSTALL
new file mode 100644
index 00000000000..9a1cc4886af
--- /dev/null
+++ b/Master/texmf-dist/doc/support/lua2dox/INSTALL
@@ -0,0 +1,42 @@
+//////////////////////
+// INSTALL
+//////////////////////
+
+Only tested for linux, but should work for any unix-like OS.
+
+For other OS you need to figure it out yourself.
+If you do, then please email me with the code/suggestions.
+
+///////////////
+// requirements
+///////////////
+A reasonably recent: doxygen and luatex.
+
+Whilst luatex isn't strictly required to make it run for TeX users
+we are more likely to have a recent version (via texlive) of texlua
+rather than relying on you, possibly aging, distro's lua.
+
+///////////////
+linux/unix:
+///////////////
+
+1) manually check if lua2dox_lua runs on your system.
+
+From the commandline run "./lua2dox_lua --help".
+If it runs and produces a sensible result then it probably works.
+
+2) Manually pick an appropriate directory for this system.
+
+Make this new directory and copy/mv all these files into there.
+If you are installing it as a personal app then put it somewhere in your
+userspace. For system-wide: ask sysadmin.
+
+3) Run "install.sh".
+This makes the links to the active code.
+
+Default is to put in "~/bin". For system-wide: ask sysadmin.
+
+Erm, that's about it.
+
+Simon
+