Skip to content

Commit

Permalink
Update README with more info on git and Docker
Browse files Browse the repository at this point in the history
Also update links to GitLab repo
  • Loading branch information
alexpovel committed Sep 28, 2020
1 parent 7c89b0d commit fa228b7
Show file tree
Hide file tree
Showing 7 changed files with 303 additions and 75 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Expand Up @@ -15,7 +15,7 @@ Chances are that what you seek is already possible with the (many) included pack
and only an example in the cookbook showing how to do it (but no change to the `*.cls`
file) is needed.

## Developing Environment
## Development Environment

The environment for compilation is taken care of by the Docker image as specified in
[the CI config file](.gitlab-ci.yml) (search for the `image` name on
Expand Down
358 changes: 297 additions & 61 deletions README.md

Large diffs are not rendered by default.

18 changes: 5 additions & 13 deletions chapters/frontmatter/preface.tex
Expand Up @@ -211,7 +211,7 @@ \subsection*{Compiling this document}
is provided.
It includes all the tools required.
For more info, see the
\href{https://collaborating.tuhh.de/cap7863/latex-git-cookbook/-/blob/master/README.md}{README}
\href{https://collaborating.tuhh.de/alex/latex-git-cookbook/-/blob/master/README.md}{README}
for the repository.

Outside tools are required for
Expand All @@ -235,21 +235,13 @@ \subsection*{Compiling this document}
will already be available as commands and ready to be invoked.
The latter means that they are on your \texttt{\$PATH}, \iecfeg{i.e.}\ the path to
the respective binaries are part of the \texttt{\$PATH} environment variable.

In summary, for everything to work, the following has to be installed:
\begin{enumerate}
\item \texttt{bib2gls} requires a Java Runtime Environment, which is
\href{https://www.java.com/en/download/}{freely available for personal use},
\item \href{https://inkscape.org/}{InkScape},
\item \href{http://www.gnuplot.info/download.html}{gnuplot}.
\end{enumerate}
For more info, refer to the
\href{https://collaborating.tuhh.de/cap7863/latex-git-cookbook#installed-packages}{README section}
For info on what else to install, refer to the
\href{https://collaborating.tuhh.de/alex/latex-git-cookbook#installed-packages}{README section}
dealing with this.

To compile the entire document from scratch, install those things manually.
To never worry about installing and keeping things in order manually, use the provided
Docker image.
Docker image!

\paragraph{Compilation}
With the prerequisites done, the compilation itself can start.
Expand Down Expand Up @@ -304,5 +296,5 @@ \subsection*{Compiling this document}
you \texttt{git push} to the remote server (or whenever you configure it to).
It does not get simpler; the downside is of course the lengthier setup, but all of that
is explained in the
\href{https://collaborating.tuhh.de/cap7863/latex-git-cookbook/-/blob/master/README.md}{README}.
\href{https://collaborating.tuhh.de/alex/latex-git-cookbook/-/blob/master/README.md}{README}.
Also, the repository itself is a live demonstration where everything is set up already!
File renamed without changes
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit fa228b7

Please sign in to comment.