summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/lua2dox/INSTALL
blob: 9a1cc4886af629c71a45b535b60fab57ad1cd6fb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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