README.md

autonotes

A tool to automatically create LaTeX documents, intended for lecture notes.

Use

Make sure you install required dependencies with

pip3 install -r requirements.txt

These commands assume that autonotes is added to your PATH variable.

init

To initialize a new note directory named myNotes run:

autonotes init -n myNotes

This creates a new directory, and creates 2 files: preamble.tex, and master.tex.

myNotes
├── master.tex
└── preamble.tex

You can optionally specify a path to an existing preamble file using -p:

autonotes init -n name -p preamble.tex

This will copy the specified preamble file into the created directory.

---

new

When you want to create a new entry, run:

autonotes new

inside a directory created by init. This creates a new .tex file, and adds that file to the master.tex file using \input{}. For example, your directory may look like this now:

myNotes
├── entry-20201231.tex
├── master.tex
└── preamble.tex

By default, the file will be named entry-{date}.tex where date is the current date. You can change the filename by using the -f option, for example:

autonotes new -f lecture

will result in lecture-20201231.tex being created

myNotes
├── entry-20201231.tex
├── lecture-20201231.tex
├── master.tex
└── preamble.tex

By default, the new entry will contain a \section{} tag with the date, but you can specify a title using -t, for example:

autonotes new -t "Title goes here"

---

add

To add an existing file to master.tex, you can use the add command.

autonotes add file

---

rm

If you want to remove an entry from the master.tex file, you can use the rm command.

autonotes rm entry-20201231.tex

will remove the \input{} line from master.tex but leave the file alone. If you want to delete the file also, use the --delete flag.

autonotes rm --delete entry-20211231.tex

---

Help

To see usage about a command, use --help, for example:

autonotes --help
autonotes init --help
autonotes new --help
autonotes add --help
autonotes rm --help