Skip to content

Commit

Permalink
improved README
Browse files Browse the repository at this point in the history
  • Loading branch information
homberghp committed May 27, 2024
1 parent dbaa917 commit f788131
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@ See how to do it.

### Fork the repository

You can fork the repository, then you immediatly have the github action file working for you and producing the pdf. See above how you then can access the pdf which will be created automatically on each push to master.
You can fork the repository, then you immediatly have the github action file working for you and producing the pdf. See above how you
then can access the pdf which will be created automatically on each push to master.

I you want to have a **private** repository, this is not possible if you fork a public repository, or you do not want to fork it, you can clone it, then just use your own remote github repository as remote repository.
I you want to have a **private** repository, you can't just fork it, as a public repository can't be made into a private one.
Easiest is to create your own repository, download the code from this one as a zip and the selectively put the files from the zip into that repository.

Remember, if you do that, please keep a link in your README.md to this one for crediting. Thx!
Remember, if you do that, please keep a link in your README.md to this one for crediting. Thanks!

### Use this as a template repository

Expand All @@ -40,32 +42,35 @@ Another option is to use this as template repository, just click on **use htis t
## Get it running manually on your machine

This manual building can be done also if you forked it, or created an own repository.
The prerequisties to build it on your own machine is a LaTeX installation. We recommend TexLive, because that brings
most rquired programs and it also plays nicely with git and git-bash.
As editor you can use visual studio code or texstudio. To build the document we have a Makefile ready
which depends on GNU-Make.

- Cloning the repository
- then build it

```
pdflatex main.tex
pdflatex main.tex
```
To simply run the latex processor once type `pdflatex main.tex`.

### Build on mac/linux with make
```
make
```
On Linux, Mac or Windows install texlive and you are good to go. Using it in combination with git-bash and gnu Make allows you to use make.
On Linux, Mac or Windows install texlive and you are good to go. Using it in combination with git-bash and GNU Make allows you to use make.

## Get it running on windows
- Install TexLive https://tug.org/texlive/
- Install Perl http://strawberryperl.com/
- Install TexLive https://tug.org/texlive/ follow the instructions there
- Install Perl http://strawberryperl.com/ for texcount
- Then build it.

### Build without latex installation.

In the repo https://github.com/sebivenlo/xelatexd, we created a Dockerfile to create a docker image which
creates a full texlive latex installation. It also provides two scripts that start the docker container and run
you latex commands inside the container. The Makefile in this directory shows how to use it.
you latex commands inside the container. The Makefile in this directory shows how to use it.

### Buildingt on overleaf.

https://www.overleaf.com provides a well engineered and very complete LaTeX build service. It also has excellent documentation.
It can be used for free, but is then limited to the number and size of your builds. For a reasonable fee, you use their standard features, which may be advisable. To build on overleaf, simply upload the zip file (or the trimmed down zipfile) to overleaf.
To make the best of the build budget, use the `\includeonly` facility of latex wisely. It will also speed up your builds when you are working on one or two chapters.

## Optional configuration
You may enable line numbering by creating an empty file in the root directory named `linenumberingOn.tex`.
Expand Down

0 comments on commit f788131

Please sign in to comment.