OpenSource
/
kaobook
mirror of https://github.com/fmarotta/kaobook.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

update README and MANIFEST 

reference #115
pull/120/head
Federico Marotta 4 years ago
parent
d411f681b1
commit
99af9b5315
3 changed files with 50 additions and 47 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      CHANGELOG.rst
  2. 36
      MANIFEST.md
  3. 57
      README.md

4
CHANGELOG.rst
Unescape View File

@ -2,6 +2,10 @@
Changelog for package kaobook
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Work in progress
----------------
* Move the packages to the root of the repository
0.9.6 (2021/03/23)
------------------
* Short margin tocs

36
MANIFEST.md
Unescape View File

@ -27,14 +27,10 @@ This work consists of all files listed below.
kaobook/
|-- kaobook.cls - book-specific definitions
|-- kaohandt.cls - handout-specific definitions
`-- styles/
|-- kao.sty - main definitions
|-- environments.sty - definitions for environments
|-- kaobiblio.sty - style of the bibliography
|-- mdftheorems.sty - colorful styling of theorems
|-- packages.sty - useful packages
|-- plaintheorems.sty - minimalistic styling of theorems
`-- kaorefs.sty - commands for referencing
|-- kao.sty - main definitions
|-- kaobiblio.sty - style of the bibliography
|-- kaotheorems.sty - colorful styling of theorems
`-- kaorefs.sty - commands for referencing
```
---
@ -55,11 +51,14 @@ their compilation.
```
kaobook/
`-- examples/
|-- books/
| `-- minimal.tex
|-- minimal_book/
| `-- main.tex
|-- minimal_report/
| `-- main.tex
|-- documentation/
| |-- main.bib
| |-- main.tex
| |-- main.tex
| |-- main.bib
| |-- glossary.tex
| `-- chapters/
| |-- appendix.tex
| |-- figsntabs.tex
@ -70,11 +69,14 @@ kaobook/
| |-- preface.tex
| |-- references.tex
| `-- textnotes.tex
`-- reports/
|-- minimal/
| `-- minimal.tex
`-- machine_learnin_project/
`-- main.tex
`-- machine_learning_project/
|-- sections/
| |-- introduction.tex
| |-- data.tex
| |-- results.tex
| `-- discussion.tex
|-- main.tex
`-- main.bib
```
As regards the files in the `kaobook/examples/documentation/images`

57
README.md
Unescape View File

@ -104,11 +104,11 @@ you can replace pdflatex with your favorite engine, like *e.g.* xelatex.
`cd` into the root of the repository, and run
```
pdflatex -output-directory examples/documentation main # The .tex is optional
pdflatex -output-directory examples/documentation main.tex
biber -output-directory examples/documentation main
pdflatex -output-directory examples/documentation main
pdflatex -output-directory examples/documentation main
pdflatex -output-directory examples/documentation main
pdflatex -output-directory examples/documentation main.tex
pdflatex -output-directory examples/documentation main.tex
pdflatex -output-directory examples/documentation main.tex
```
To compile the glossary and nomenclature as well, `cd` into the
@ -132,11 +132,14 @@ To update kaobook you should download the whole repository (or one of
the releases) again, and replace all of your old files with the newer
ones, *except* for the main.tex and the files that you have created,
like the chapters of the book. The crucial files that pertain to kaobook
and that you always have to update are:
and that you should always update are:
1. `kaobook.cls`;
2. `kaohandt.cls`;
3. the whole `styles` directory.
3. `kao.sty`;
3. `kaobiblio.sty` (optional);
4. `kaorefs.sty` (optional);
5. `kaotheorems.sty` (optional);
These files should be in the same folder as your `main.tex`. Even if a
file has not been modified, I would still suggest to replace everything
@ -144,15 +147,15 @@ because it is easier.
In practice, I would do as follows. I would have a directory, called for
example 'my\_book', with all the files necessary for the book:
`kaobook.cls`, `kaohand.cls`, the `styles` directory, and the
`main.tex`. I like to have a separate file for each chapter, so I would
also have a directory called `chapters`, with all the `.tex` files with
the actual chapters. Then, when I want to update kaobook, I would
download the GitHub repository (or one of the releases) into a directory
called 'kaobook', and finally copy the `kaobook.cls`, `kaohandt.cls`,
and the whole `styles` directory from 'kaobook' to 'my\_book'. Once the
update is completed, the whole 'my\_book' directory can be uploaded on
Overleaf or on a personal ShareLaTeX server.
`kaobook.cls`, `kaohand.cls`, the `*.sty` files, and the `main.tex`. I
like to have a separate file for each chapter, so I would also have a
directory called `chapters`, with all the `.tex` files with the actual
chapters. Then, when I want to update kaobook, I would download the
GitHub repository (or one of the releases) into a directory called
'kaobook', and finally copy the `kaobook.cls`, `kaohandt.cls`, and the
whole `styles` directory from 'kaobook' to 'my\_book'. Once the update
is completed, the whole 'my\_book' directory can be uploaded on Overleaf
or on a personal ShareLaTeX server.
Alternatively, advanced users can download the repository in their local
texmf tree; see the [instructions](instructions) directory for hints.
@ -161,22 +164,15 @@ texmf tree; see the [instructions](instructions) directory for hints.
There are two main class files: `kaobook.cls`, used for books, and
`kaohandt.cls`, used for reports or handouts; both heavily rely on
`styles/kao.sty`, which contains the bulk of the definitions that are
common to both classes. In the future there may be another class for
theses.
`kao.sty`, which contains the bulk of the definitions that are common to
both classes. In the future there may be another class for theses.
Some examples and templates are listed in the `examples` directory. The
book that documents the class is an example itself, and the pdf has been
copied to the root of the repository so that it will be found more
easily.
Please make sure that you add the appropriate `styles` directory
and one of the main class files (`kaobook.cls`, used for books, and
`kaohandt.cls`, used for reports or handouts) to the folders of the
examples. This is important if you want to try out the examples by
yourself. Read the explanations inside the `examples` folder.
The `styles` directory contains additional packages that are used by the
The `*.sty` files contain additional packages that are used by the
class, but in principle they are independent of it (even though in
practice it is still not so).
@ -217,11 +213,12 @@ kaobook class, consisting of `kaobook.cls`, `kaohandt.cls`, and
on the other hand, the templates and the examples in the `examples`
directory.
The first work is licensed under the [LaTeX Project Public License](https://www.latex-project.org/lppl/), so if
you want to modify and/or distribute the `*.cls` and `*.sty` files
pertaining to this work you have to complain with the terms of the
license. However, if you just want to use the class to compile your
documents you need not worry about the license.
The first work is licensed under the [LaTeX Project Public
License](https://www.latex-project.org/lppl/), so if you want to modify
and/or distribute the `*.cls` and `*.sty` files pertaining to this work
you have to complain with the terms of the license. However, if you just
want to use the class to compile your documents you need not worry about
the license.
The second work is released into the public domain with a Creative
Commons Zero License.

Write Preview
Loading…
Cancel
Save