Skip to content

Commit d6a48b2

Browse files
authored
Updated to reflect changes in v2.2
Updated the version history, list of commands and other minor details.
1 parent 8c10821 commit d6a48b2

File tree

1 file changed

+36
-6
lines changed

1 file changed

+36
-6
lines changed

README.md

+36-6
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
**Webpage:** [http://vhbelvadi.com/latex-lecture-notes-class/](http://vhbelvadi.com/latex-lecture-notes-class)
1111

12-
**Current release:** v2.1 <a href="https://github.com/vhbelvadi/LaTeX-lecture-notes-class/releases/latest"><img src="https://img.shields.io/badge/Download-latest%20release-brightgreen.svg" style="vertical-align: text-bottom;margin-left: 24px;"></a>
12+
**Current release:** v2.2 <a href="https://github.com/vhbelvadi/LaTeX-lecture-notes-class/releases/latest"><img src="https://img.shields.io/badge/Download-latest%20release-brightgreen.svg" style="vertical-align: text-bottom;margin-left: 24px;"></a>
1313

1414
**Description:** A LaTeX document class built for lecture notes for classes/seminars, entire courses or brief talks.
1515
A detailed article about this class can be found on [the author's website](http://vhbelvadi.com/latex-lecture-notes-class/).
@@ -126,6 +126,9 @@ There are some additional commands you can use _inside your document_, i.e. with
126126
2. `\separator` for use in `talk` type documents to draw a visually helpful horizontal separator line
127127
3. `\tosay{message}` for use in `talk` type documents to print messages inside a box to help recall important data
128128
4. `\margintext{message}` to make useful notes in the margin
129+
5. `\\` at the start of a paragraph to give it a line break and remove any indentation
130+
6. `\nl ` at the start of a paragraph without either a line break or an indent (note the space following the command)
131+
7. `\runin{}` as a handy approach to print texts in small caps (especially useful to start new sections/chapters/parts of a document)
129132

130133
### Dependencies
131134

@@ -135,11 +138,38 @@ There are some additional commands you can use _inside your document_, i.e. with
135138

136139
(Besides any bug fixes)
137140

138-
- 2.1 New season data added (especially for a `course` that stretches across weeks/months), US date support
139-
- 2.0 Blank header (`headerno`) issue solved, defaults are no longer ugly
140-
- 1.2 French language support
141-
- 1.1 Improved default headers
142-
- 1.0 Initial release
141+
### 2.2
142+
- Title data footnotes will no longer mention '(speaker)' unless the author's email is also specified
143+
- Added spacing around the em dash between the course code and title at the head of the document
144+
- Improved styling for the explicit line break character
145+
- Improved caption style
146+
- **New command** The new command `\\` provided by this class adds a new paragraph with a line break and without an indent. Use this to mark the _start_ of a new paragraph rather than the end of the previous one:
147+
```
148+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur porttitor et lectus sit amet scelerisque.
149+
150+
\\Nam orci leo, tincidunt id convallis eu, luctus id nisi...
151+
```
152+
- **New command** The `\nl` command provided by this class adds a new paragraph without indent or a line break. Use this same as the previous command but with a space after the command itself.
153+
- **New command** The `\runin{}` command provided by this class adds small caps. This can be done manually but is a handy approach that is especially useful to start new sections/chapters/parts of a document.
154+
155+
#### 2.1
156+
- All options except title are now optional
157+
- New season data added (especially for a `course` that stretches across weeks/months)
158+
- Support for the US date format mm/dd/yyyy
159+
- French translation improvements
160+
161+
#### 2.0
162+
- Blank header (`headerno`) bug fixed
163+
- Improved default headers
164+
165+
#### 1.2
166+
- French language support
167+
168+
#### 1.1
169+
- Improved default headers
170+
171+
#### 1.0
172+
- Initial release
143173

144174
## The road ahead
145175

0 commit comments

Comments
 (0)