Switched to markdown files (README, CHANGELOG).

This commit is contained in:
Ricardo Langner
2015-06-29 21:18:33 +02:00
parent 5a2a18b224
commit 0e5688da72
4 changed files with 37 additions and 59 deletions

2
.gitignore vendored
View File

@@ -11,3 +11,5 @@
*.toc
*.bcf
*.fdb_latexmk
README.html
CHANGELOG.html

View File

@@ -1,24 +1,24 @@
# Clean Thesis changelog
The latest version of this file can be found at the master branch of the
cleanthesis repository.
*Clean Thesis* [repository](https://github.com/derric/cleanthesis).
=== Latest Dev ===
## Latest Dev
- Created this changelog text file
- Fixed broken package option/parameter colorize (hrzbrg)
- Fixed changing font size of the document to small caused by a bug in the titlepage (matthieu-lapeyre)
- New package option bibfile: allows you to link/use arbitrary bibtex files
- New package option bibstyle: allows you to set a citation and bibliography style
=== v0.2.3 ===
## v0.2.3
- Fixed line breaks for long chapter headlines (caused text overlapping)
- Fixed wrong file names to the main latex file for the example document
=== v0.2.2 ===
## v0.2.2
- Fix: added address for postcards
- Doc: improved acknowledgments, added André Miede
=== v0.2.1 ===
## v0.2.1
- Fix: make horizontal line longer (just a bit)
- Fix: update my address (new)
- Change: add my name to the colophon
@@ -26,11 +26,11 @@ cleanthesis repository.
- Feature: new package option for citation management tool (bib engine), biber or bibtex
- Doc: add first people to acknowledgments
=== v0.2 ===
## v0.2
- Fix: label widths in the lof and lot (list of figures, list of tables)
- Feature: more flexible/new package options
- Feature: improved color management, introduction of color themes (currently two)
- Doc: Initial documentation (package options)
=== v0.1 ===
## v0.1
- Initial public beta version

52
README
View File

@@ -1,52 +0,0 @@
Clean Thesis
-- A LaTeX Style for Thesis Documents --
Copyright (C) 2011-2015 Ricardo Langner
Readme:
----------------------------------------
*** Clean, Simple, Elegant ***
"Clean Thesis" is a LaTeX style for thesis documents, developed
for my diploma thesis (Diplomarbeit). The style can be understood
as my personal compromise — a typical clean looking scientific
document combined and polished with minor beautifications.
The design of this "Clean Thesis" style is inspired
by user guide documents from Apple Inc.
Note: If you are looking for an exact and correct style regarding
typographic rules, please have a look at the "Classic Thesis Style"
(see http://www.miede.de/#classicthesis).
*** Donation = Postcard ***
Based on the idea of Andr\'e Miede: If you like the "Clean Thesis"
style I would be very pleased about a donation in the form of a
POSTCARD. You can find my address at http://cleanthesis.der-ric.de/
as well as in the file Clean-Thesis.pdf. I am going to collect all
postcards and exhibit them at the website I mentioned.
*** Idea and Inspiration ***
The idea of providing my customized style for thesis documents
passed through my mind while writing my own thesis. Motivated and
inspired by the superb "Classic Thesis Style"
(see http://www.miede.de/#classicthesis) by Andr\'e Miede
(thanks to Andr\'e for doing a great job) I decided to collect all
design and style related functionality in a separate LaTeX style and
provide this style to other thesis writers.
License Information:
----------------------------------------
"Clean Thesis" is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
"Clean Thesis" is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

28
README.md Normal file
View File

@@ -0,0 +1,28 @@
# Clean Thesis
*-- A LaTeX Style for Thesis Documents --*
*Copyright (C) 2011-2015 Ricardo Langner*
## Readme:
**Clean, Simple, Elegant**
*Clean Thesis* is a LaTeX style for thesis documents, developed for my diploma thesis (Diplomarbeit). The style can be understood as my personal compromise — a typical clean looking scientific document combined and polished with minor beautifications.
The design of this *Clean Thesis* style is inspired by user guide documents from Apple Inc.
Note: If you are looking for an exact and correct style regarding typographic rules, please have a look at the "[Classic Thesis Style](see http://www.miede.de/#classicthesis)".
**Donation = Postcard**
Based on the idea of André Miede: If you like the *Clean Thesis* style I would be very pleased about a donation in the form of a POSTCARD. You can find my address at the *Clean Thesis* [website](http://cleanthesis.der-ric.de/) as well as in the [documentation](Clean-Thesis.pdf). I am going to collect all postcards and exhibit them at the website I mentioned.
**Idea and Inspiration**
The idea of providing my customized style for thesis documents passed through my mind while writing my own thesis. Motivated and inspired by the superb "[Classic Thesis Style](see http://www.miede.de/#classicthesis)" by André Miede (thanks to André for doing a great job) I decided to collect all design and style related functionality in a separate LaTeX style and provide this style to other thesis writers.
## License Information:
*Clean Thesis* is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
*Clean Thesis* is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.