optidef (27jun16)

git-svn-id: svn://tug.org/texlive/trunk@41551 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 23 insertions, 11 deletions

diff --git a/Master/texmf-dist/doc/latex/optidef/README.md b/Master/texmf-dist/doc/latex/optidef/README.md
index 69c9ae4fc04..272cd586561 100644
--- a/Master/texmf-dist/doc/latex/optidef/README.md
+++ b/Master/texmf-dist/doc/latex/optidef/README.md
@@ -2,15 +2,16 @@
 
 Optidef is a small library that provides a standard set of environments for writing optimization problems. 
 
-## Features:
+
+## Features
 
 The most important features are:
 
 - It automatically aligns the problems in the most convenient way allowing even two different output formats:
    * Beginning of the words "minimize/argmin" and "subject to"
    * Double format for the location of the constraints: either to the right of  subject to aligned with the objective function or below subject to.
-   * The $= | > | <$ signs of the constraints.
-   * Optionally, the user can add manually a double align character \&\& to align some common constraints feature. A clear example could be the constraints names, e.g. (boundary constraint) alignment with (dynamic constraint), or the index of the constraints, e.g. in the case of having something like $h(x_k,u_k)\leq 0,\quad k=0,\ldots,N$, align the indexes $k=0,\ldots,N$ across constraint lines.
+   * The =, > and < signs of the constraints.
+   * Optionally, an alignment point for some constraints features. An example could be the constraints names, e.g. align (boundary constraint) with (dynamic constraint), or the index of the constraints, e.g. in the case of having something like h(xk,uk) < 0, k=0, ...,N, the third alignment point can align the constraint indexes k=0, ...,N across different constraint lines.
 
 
 - It provides an easy interface to define optimization problem for three different reference situations:
@@ -25,9 +26,13 @@ The most important features are:
    * maximize
    * arg mini
    * arg maxi
- 
 
-## Syntax:
+## Usage
+
+Import the package by directly adding \usepackage{optidef} to your LaTeX document. Consult the documentation for different examples and syntax usage.
+
+
+## Syntax
     
 The syntax to define an optimization problem is given by:
  
@@ -35,12 +40,13 @@ The syntax to define an optimization problem is given by:
             {Optimization variable}
             {Objective function \label{Objective function referece}}
             {\label{Global referece of Optimization Problem}}  
-            {Result of the optimization problem or any expression on the left of the minimize word}
-            \addConstraint{LHS Constraint 1}{RHS Constraint 1 \label{Reference Constraint 1}}
-            \addConstraint{LHS Constraint 2}{RHS Constraint 2 \label{Reference Constraint 2}}
+            {Result of the optimization problem or any expression on the left
+            of the minimize word}
+            \addConstraint{LHS Constraint 1}{RHS Constraint 1 \label{Reference Constraint 1}}{Extra Info Constraint 1}
+            \addConstraint{LHS Constraint 2}{RHS Constraint 2 \label{Reference Constraint 2}}{Extra Info Constraint 2}
             .
             .
-            \addConstraint{LHS N}  {RHSConstraint N \label{Reference Constraint N}}
+            \addConstraint{LHS N}{RHSConstraint N \label{Reference Constraint N}}{Extra Info Constraint N}
         \end{mini#}
 
 
@@ -57,11 +63,17 @@ After the definition of this parameters, the environment accepts the definition
 
 Finally note that \begin{mini#} can be substituted by \begin{maxi#}, \begin{argmini#} or \begin{argmaxi#}. 
 
-## Contact:
+## Contact for issue reporting or suggestions
 
 E-mail: jesus.lago.garcia@venus.uni-freiburg.de
 
-## Licensing:
+Github: https://github.com/jeslago/optidef
+
+## Latest stable version: Optidef 1.1
+
+CTAN: https://www.ctan.org/pkg/optidef
+
+## Licensing
 
 Copyright 2016 Jesus Lago Garcia