NotesTeX/README.md

69 lines
2.5 KiB
Markdown
Raw Normal View History

2017-09-21 17:00:33 -04:00
<p align="center">
<h3 align="center">NotesTeX</h3>
<p align="center">
An All-In-One Notes Package For Students
<br>
<a href="http://geodesick.com/">Website</a>
</p>
</p>
<br>
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
2017-09-21 17:00:33 -04:00
## Preview
| Page. 1 | Page. 2 |
|:---:|:---:|
2017-09-21 17:03:40 -04:00
| [![Preview](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample1.png)](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample1.pdf) | [![Preview](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample2.png)](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample2.pdf) |
2017-09-21 17:00:33 -04:00
| Page. 3 | Page. 4 |
|:---:|:---:|
2017-09-21 17:03:40 -04:00
| [![Preview](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample3.png)](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample3.pdf) | [![Preview](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample4.png)](https://raw.githubusercontent.com/adhumunt/NotesTeX/master/Sample/Sample4.pdf) |
2017-09-21 17:00:33 -04:00
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}
```
2017-09-21 17:00:33 -04:00
## Documentation
2017-09-20 12:02:22 -04:00
All the documentation of this package is given in [NotesTeX.pdf](NoTeX/NotesTeX.pdf) and if you have any questions feel free to contact me.
2017-09-18 12:29:15 -04:00
## License
2017-09-21 17:00:33 -04:00
This material is subject ot the [LaTeX Project Public License](LICENSE).
## Version and Contact
> NotesTeX v2.0.
> Created by Aditya Dhumuntarao.
> Date: September 21, 2017.
> E-mail comments and suggestions to adhumunt@gmail.com.