Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.51 KB

README.md

File metadata and controls

52 lines (33 loc) · 2.51 KB

Configuration

Create a new repository from the template

Follow Github's guide to create a new repository from this template.

Import class and bibliography style files

Download the .cls and .bst files provided by the target conference or journal into the src directory.

Open Makefile and point the CLS and BST variables to the downloaded .cls and .bst files, respectively.

Import a paper template

Download the sample paper provided by the target conference or journal, reduce it to a minimum working example and paste its contents into paper.tex.

Reuse glossary entries

Add the following snippet to the preamble of paper.tex to pick up the glossary entries provided in this template:

\input{glossary.tex}

Import figures

Store figures in the fig directory. Any .svg files in this directory will be automatically converted to .pdf using Inkscape.

Auto-generate results

If you have any auto-generated results, open Makefile and add the rules to generate the results in the relevant section at the bottom of the file. Make sure the results are generated in the res folder, and list all results the paper depends on in the RESULTS variable.

Import auxiliary documents

If you have any additional Latex documents, e.g. cover letter and summary of changes, which do not include a bibliography, store them in the src folder, open Makefile and add their names to the DOCS variable.

Track submitted papers

Submitted papers can be saved in the sub directory.

Usage

Once configured, the repository provides the following Make targets:

Target Description
results Regenerate results.
paper Build the paper.
docs Build all additional documents.
all Invoke all of the above.
diff REV1=HEAD^ REV2=HEAD To generate a diff of the paper between the specified revisions. If omitted, the REV* variables default to the mentioned values.
blind Build an obfuscated version of the paper for double-blind review. The blindreview variable implicitly defined by this command can be used within the paper source to conditionally obfuscate content.
clean-paper Deletes all artifacts of the paper and diff targets.
clean Deletes all artifacts.