summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/lettre/README
blob: 23d15a39a50c7c3df5c0d746152cb9515487a55a (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
92
93
94
95
96
97
98
99
100
101
102
103
104
License
=======
This file is part of the "lettre" package.
Copyright 2000-2013 Denis M\'gevand
Copyright 2013-2017 Vincent Bela\"iche

This work may be distributed and/or modified under the conditions of the
LaTeX Project Public License, either version 1.3 of this license or (at your
option) any later version.  The latest version of this license is in
http://www.latex-project.org/lppl.txt and version 1.3 or later is part of all
distributions of LaTeX version 2005/12/01 or later.

This work has the LPPL maintenance status `maintained'.

The Current Maintainer of this work is Vincent Bela\"iche.

This work consists of all files listed hereinafter:
lettre.zip/lettre.dtx
lettre.zip/lettre.pdf lettre.zip/README lettre.zip/ALIRE

lettre.zip/lettre.tds.zip/doc/latex/lettre/lettre.pdf lettre.zip/lettre.tds.zip/doc/latex/lettre/README_TDS lettre.zip/lettre.tds.zip/doc/latex/lettre/ALIRE_TDS

lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre.cls lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-english.ldf lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-french.ldf lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-german.ldf lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-romand.ldf lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-USenglish.ldf lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-amg.cfg lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-obs.cfg lettre.zip/lettre.tds.zip/tex/latex/lettre/lettre-default.cfg

lettre.zip/lettre.tds.zip/doc/latex/lettre/3.000-release-notes

Lettre
======
author:		Denis M\'egevand
maintainer:	Vincent Bela\"iche
version:	3.000
date:		2017/08/03
Email:		vincentb1@users.sourceforge.net

New features and bug corrections are described in the file 3.000-release-notes.

The documentation (only available in french) is provided in file 
lettre.zip/lettre.pdf, the source code for documentation can be extracted from the
lettre.dtx file as explained hereinafter.

Installation
============
Installation is very simple, the only sensitive files are lettre.cls and
default.ins which are to be put in the macro path, usually hidden behind the
environment variable $TEXINPUTS.


Please proceed as follows:

	1) extract file lettre.dtx from lettre.zip to a temporary directory named e.g.
	   LETTRE.

	2) in the LETTRE directory, type command:

		latex lettre.dtx

	   so that all files packed within lettre.dtx are extracted.


	3) place files lettre.cls and default.ins into ${TEXINPUTS}/tex/latex/lettre, where
	   ${TEXINPUTS} denotes the installation TDS tree.



	4) refresh your file name data base (Under MiKTeX click on
	  "refresh FNDB" button in the administation pannel)

	5) the manual is also available in lettre.zip, you should place it under
	   ${TEXINPUTS}/doc/latex/lettre

	6) if you wish to recompile the manual, in the dezip directory LETTRE, type command :

	   latexmk -r latexmkrc.pl

	  this needs that latexmk perl script is installed in your LaTeX
      distribution, which is in general true. Otherwise you can get it from there:

		http://ctan.org/pkg/latexmk

	
Usage
=====
Print, then follow the documentation. The examples give real letter and telefax
source codes that are compiled with the class along with the PDF output included
as a picture in the manual. Try to compile them to check the package against
your LaTeX installation.

SVN Repository
==============

If you want to get the development version, the project is under the GNA! forge,
you need the svn (Subversion) utilitary to check it out with one of the two
following commands:

svn co svn://svn.gna.org/svn/lettre_observatoire/trunk lettre_observatoire
svn co http://svn.gna.org/svn/lettre_observatoire/trunk lettre_observatoire

The v3.000 version that you have in hands can be checked out with
one of the two following commands:

svn co svn://svn.gna.org/svn/lettre_observatoire/tags/ctan3.000 lettre_observatoire
svn co http://svn.gna.org/svn/lettre_observatoire/tags/ctan3.000 lettre_observatoire