Separate creating the title page and including it in manuscript

[modosist/iidtitlepage.git] / README.md

diff --git a/README.md b/README.md
index 700dfd3265adc5133df944a689f78a12ade29d29..f9b11aee064c9764629eea9a1a88a29d38eb737c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,51 +1,37 @@
 # Documentation for `iidtitlepage` package
 TODO: what is it
 
+## Package usage
+The process of adding the title page to your manuscript is following:
 
-## Package installation
-Put files `iidtitlepage.sty` and `iid-logo.pdf` into the root directory of your article, i.e., where your main `.tex` file is located.
-The package has a few dependencies, you may either check them in `.sty` file (`\RequirePackage` commands) or just keep building your article until you will have no errors left ;).
-
-TODO: installation to system LaTeX?
+1. Create the PDF file of title page with all the information.
+2. Include the title page into your manuscript.
 
-## Package usage
-File `example.tex` shows a complete example on how to use the package.
+### Creating the title page PDF
+First, either download the whole `iidtitlepage` project or clone its git.
+To change the information on the title page (such as name of the authors, title etc.), edit the file `title_page.tex` using your favorite editor and follow the LaTeX comments to include the necessary info.
+Build the title page PDF using `pdflatex` command.
 
-To import the package, use following
+### Including the title page into your manuscript
+Copy the generated title page `title_page.pdf` to directory with your manuscript LaTeX project.
+Include a `pdfpages` package into your project
 ```latex
-\usepackage[elsevier]{iidtitlepage}
+\usepackage{pdfpages}
 ```
-The package has one mandatory argument which is either `elsevier` or `ieee`, depending on the publisher of your article.
-
-Then, you need to provide some mandatory information such as title name, authors, year and citation text
-```latex
-% Title.
-\title{An example document using \texttt{iidtitlepage} package}
 
-% Authors.
-% Unfortunately, we cannot use \author command, since some journal templates require to use a specific macros that might be not compatible with the package.
-\IidTitlePageAuthors{Istv\'{a}n M\'{o}dos, Va\v{s}ek Chv\'{a}tal}
+The following action depends on the journal publisher.
 
-% Year of publication.
-\IidTitlePageYear{2017}
-
-% How to cite this article. Can be either full-text or, as in this case, a bibtex entry.
-\IidTitlePageCiteAs{modos2018}
-```
-
-You may specify some optional information such as DOI and source code url
+#### Elsevier
+Locate `\begin{frontmatter}` command and replace it with the following
 ```latex
-\IidTitlePageDoi{https://doi.org/10.1016/j.cie.2017.08.011}
-\IidTitlePageSourceCodes{https://github.com/torvalds/linux}
+\begin{frontmatter}
+\includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
 ```
 
-After all information is specified, call `\IidTitlePage{}` to create a title page
+#### IEEE and Springer
+Locate `\maketitle` command and replace it with the following
 ```latex
-\begin{document}
-...
-\IidTitlePage{}
-...
+\null
+\includepdf[pages=1,fitpaper,noautoscale]{title_page.pdf}
 \maketitle
-...
-\end{document}
-```
+```
\ No newline at end of file