NotesTeX/README.md

48 lines
1.5 KiB
Markdown
Raw Normal View History

2017-09-18 12:10:06 -04:00
# The NotesTeX Package
2017-09-18 12:29:15 -04:00
2017-09-20 11:52:31 -04:00
> NotesTeX v1.1.
2017-09-18 12:23:21 -04:00
> Created by Aditya Dhumuntarao.
> Date: September 18, 2017.
> E-mail comments and suggestions to adhumunt@gmail.com.
2017-09-18 12:27:51 -04:00
---
2017-09-18 12:29:15 -04:00
## Purpose
2017-09-18 12:10:06 -04:00
_NotesTeX_ is a modification of the original Jhep journal format in order to suit the needs of students in university.
2017-09-18 11:48:50 -04:00
## Installation
Installing just requires the following steps:
2017-09-18 17:32:20 -04:00
1. **Download** the [zip archive](NoTeX.zip).
2017-09-18 12:10:06 -04:00
2. **Build** the NotesTeX.tex file. This compile should work without a problem, and it should look like the pdf attached below.
3. **Move** the NotesTeX.sty file where ever you need it, and let your new notes file call to it as provided in the example below.
2017-09-18 11:48:50 -04:00
## Usage
Here is an example of a test page:
```latex
\documentclass{article}
2017-09-18 17:32:20 -04:00
\usepackage{/Path/to/package/NotesTeX} %/Path/to/package should be replaced with package location
2017-09-18 11:48:50 -04:00
\usepackage{lipsum}
\title{{\Huge Test Page Title}\\{\Large{Test Page Subtitle}}}
\author{Author Name\footnote{\href{https://google.com/}{\textit{Author Website}}}}
\affiliation{Affiliation of Author}
\emailAdd{Email of Author}
\begin{document}
\maketitle
\flushbottom
\newpage
2017-09-19 09:34:56 -04:00
\pagestyle{fancynotes}
2017-09-18 11:48:50 -04:00
\part{Test Part 1}
2017-09-20 11:54:19 -04:00
\lipsum[1]
2017-09-18 11:48:50 -04:00
\section{Subtest Section 1}
2017-09-19 09:34:56 -04:00
Some notes here.\sn{With some additional sidenotes}
2017-09-18 11:48:50 -04:00
\end{document}
```
## Details
2017-09-18 17:32:20 -04:00
All the documentation of this package is given in NotesTeX.pdf and if you have any questions feel free to contact me.
2017-09-18 12:29:15 -04:00
## License
2017-09-18 12:47:32 -04:00
This material is subject ot the [LaTeX Project Public License](LICENSE).