Skip to content

Commit

Permalink
README fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
ybwu committed Jan 8, 2019
1 parent 8316816 commit 84a5203
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# A Template for Academic Writing Projects

The repository contains a template for writing NLP/ML papers (using latex).
By no mean one could write a great article by filling a template,
By no mean one could write great articles by filling a template,
but we hope this project could help less experienced researchers
to grasp key aspects of an academic paper.

In the template, we try to give a detailed TODO list for each paper section
In the template, we try to give a detailed todo list for each paper section
(see texts in `docs/antnlp-tawp.pdf`),
a workflow for a new writing project,
and a flavor of using latex packages.
and a flavor of using latex.


## Files and Directories
Expand All @@ -20,22 +20,22 @@ to facilitate collaborative writing.
if some images are generated by other programs (e.g., source codes of matplotlib).
- `antnlp-tawp/supplementary`: your latex source files for the supplementary.

Instead of "fig1.pdf, fig2.pdf, paper.tex, my-paper.tex"
we suggest naming the files properly (e.g., "pr-curve.pdf", "inorder-dep-parsing.tex").
Instead of "fig1.pdf, fig2.pdf, paper.tex, my-paper.tex",
we suggest naming files with clear meaning (e.g., "pr-curve.pdf", "inorder-dep-parsing.tex").


## A Workflow

When you start a new paper, we suggest going with the following steps
1. list the motivations (e.g., problem importance/challenges) in the _introduction section_.
1. list the motivations (e.g., problem importance/challenges) in the _introduction_ section.
It helps you to build a complete picture of your paper.
1. list experiments.
1. draw the key figures of your model. It helps you to organize the _approach section_.
1. write _approach section_.
1. write _introduction_ and _abstract_.
1. write _experiments_.
1. write _related work_.
1. write _conclusion_.
1. draw the key figures of your model. It helps you to organize the _approach_ section.
1. the _approach_ section.
1. the _introduction_ section and the _abstract_.
1. the _experiments_ section.
1. the _related work_ section.
1. the _conclusion_.

The workflow should starts at least 1 month before your deadline.

Expand All @@ -51,5 +51,5 @@ The workflow should starts at least 1 month before your deadline.
- Windows: ppt + kLatexFormula
- Linux: wps+`images/latex2emf.py` (a linux version of kLatexFormula is available.
However, the current version of linux wps can not directly import emf file from clipboard.
We still need to do the import job manually.)
We still need to do the importing job manually.)

0 comments on commit 84a5203

Please sign in to comment.