summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/mycv/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/mycv/README')
-rw-r--r--Master/texmf-dist/doc/latex/mycv/README61
1 files changed, 42 insertions, 19 deletions
diff --git a/Master/texmf-dist/doc/latex/mycv/README b/Master/texmf-dist/doc/latex/mycv/README
index 35b74c9b8d7..329f150219e 100644
--- a/Master/texmf-dist/doc/latex/mycv/README
+++ b/Master/texmf-dist/doc/latex/mycv/README
@@ -1,7 +1,7 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% %
-% MyCV class (v1.5.5) %
-% 2012-05-13 %
+% MyCV class (v1.5.6) %
+% 2012-05-20 %
% %
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -41,39 +41,62 @@ A basic support for TikZ decorations is also provided.
---------------------------------------------------------
The base directory of this bundle has the following files
-and sub-directories:
+and sub-directories
---------------------------------------------------------
-'README' -- this file
-'CHANGELOG -- the revision history
-'mycv.cls' -- the main class file
-'mycv_*.def' -- files to support the main
- class implementation
-'mycv_*.sty' -- class extensions
-'mycv.pdf' -- the documentation file
-'mycv_*.pl' -- a Perl script (see the doc. file)
-<Examples> -- directory with some examples
-<Doc> -- contains the documentation sources
+'README' -- this file
+'CHANGELOG -- the revision history
+'mycv.dtx' -- the main source file
+'checksum.pl' -- verify the integrity of the main files
+'mycv.pdf' -- the documentation file
+<Examples> -- directory with some examples
+<Doc> -- contains the documentation sources
+
+The following files are also created when extracting
+the 'mycv.dtx' contents (see 'Class installation' below).
+
+ ** the main class file
+ 'mycv.cls'
+
+ ** support for the main class implementation
+ 'mycv_[base|misc|version].def'
+
+ ** class extensions
+ 'mycv_[style|dec].sty'
+
+ ** split the contents of a file (see the doc.)
+ 'mycv_split_contents.pl'
------------------
Class installation
------------------
-*) In order to install this class, move all files with
- extensions '.def', '.sty' and '.cls' into a folder
- searched by LaTeX; the update of the LaTeX database
- might be necessary to complete the installation.
+*) Extracts the content of the file 'mycv.dtx'. It is
+ done by typing the command:
+
+ (pdf)latex mycv.dtx
+
+*) Moves all files with extensions '.def', '.sty' and
+ '.cls' into a folder searched by LaTeX; the update
+ of the LaTeX db might be necessary to complete the
+ installation.
*) Optionally, the Perl script 'mycv_split_contents.pl'
may be copied to a folder in the 'PATH' environment
- variable.
+ variable; on Unix-like systems, it's also necessary
+ to make the script executable.
+
+*) To check the integrity of the main files, the script
+ 'checksum.pl' (it does not provide any argument) may
+ be executed, provided that it's executable (only for
+ Unix-like systems).
-------------
Documentation
-------------
To create the documentation, move to the <Doc> folder
-and run 'mycv.tex' twice through pdfLaTeX. Due to the
+and run 'mycv.tex' twice through pdflatex. Due to the
use of some TikZ decorations, it may take awhile.
--------