summaryrefslogtreecommitdiff
path: root/support/try/README
blob: 9589f5c2afae913814134354b884952c579f2e12 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# TrY #

Automation of the TeX/LaTeX compilation.

Author: Ajabu Tex <ajabutex@gmail.com>  
Version: 4.0 - Release 2013-2014

* * *

Program for the automation of the compilation of (La)TeX documents.
Scans the commands from the comment lines of the document and executes
them automatically.

Great attention is paid to the flexibility and ease of use.


## Limitations ##

TrY is written for Linux and works on Linux. I didn't test the program
on Windows.  **CAUTION: I don't know if the program properly works on
Windows.  I think not.**


##  Contents of the package ##

* try.nw: the source code for the program and the documentation
* try: the python program
* try-doc.pdf: the documentation
* README: this file
* COPYING: GNU GPL license informations


## How to compile it ##

The source file (`try.nw`) is written in [noweb][*], a tool by
Norman Ramsey for [_Literate Programming_][**]. To extract and
compile the program and the documentation use the following commands:

program

    $ notangle -Rtry try.nw > try
    $ chmod +x try

documentation

    $ noweave -index -latex try.nw > try-doc.tex
    $ pdflatex try-doc.tex
    $ pdflatex try-doc.tex
    $ pdflatex try-doc.tex


## Installation ##

Make the file `try` executable then copy it into the `bin` directory of
your system, e.g.:

    $ chmod +x try 
    $ sudo cp try /usr/bin/try


## Use ##

Open a terminal and use the following command line:

    $ try [file [--log] [--safe] [--verbose] | --help | --version]
    $ try [file [-l] [-s] [-v] | -h | -V]

More on this in `try-doc.pdf`


## Contributing ##

If you want to fork the project or if you want to send a pull request,
or simply download the latest version go to

<https://bitbucket.org/ajabutex/try>
    

## License ##

This material is subject to the GPL - GNU General Public License. See

<http://www.gnu.org/licenses/gpl.txt>

for the details of that license.


Happy TeXing.

[*]: http://www.cs.tufts.edu/~nr/noweb/
[**]: http://www.literateprogramming.com/