From e921077c4ad0fb5b829b5bbafccb492b1658017e Mon Sep 17 00:00:00 2001
From: Wu Zhenyu <Wuzy01@qq.com>
Date: Sun, 31 Jan 2021 19:24:01 +0800
Subject: [PATCH] Update README.md

---
 README.md | 89 ++++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 75 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 685181e..0f53294 100644
--- a/README.md
+++ b/README.md
@@ -10,27 +10,40 @@ Dependent
 2. [cnlogo]: provide Chinese university logos. Include the logo of Nanjing
     University of Science and Technology.
 
-Install
+Compile
 -------
 
-``` {.zsh}
-# for GNU
-cd ~/.texlive/texmf-var/tex/latex
-# for Windows
-cd C:\Program Files\texlive\texmf-local\tex\latex
+```shell
 git clone git@github.com:Freed-Wu/njustthesis.git
 latexmk -pvc- njustthesis/njustthesis.ins
-# for GNU
+```
+
+You will get a file named `njustthesis.cls`.
+
+If you don't wanna install the package, make sure `njustthesis.cls` and your
+`main.tex` in a same path in order to latex engine can find it.
+
+Install
+-------
+
+Move `njustthesis.cls` in the path of your tex distribution store its
+packages, and update.
+
+And make sure you have installed `cnlogo`.
+
+### GNU
+
+```shell
+mv njustthesis.cls ~/.texlive/texmf-var/tex/latex
 texhash ~/.texlive/texmf-var
-# for Windows
-texhash
 ```
 
-Usage
------
+### Windows
 
-Examples:
-[Freed-Wu/random-signal-process-experiment](https://github.com/Freed-Wu/random-signal-process-experiment)
+```shell
+move njustthesis.cls C:\Program Files\texlive\texmf-local\tex\latex
+texhash
+```
 
 Customize
 ---------
@@ -39,6 +52,7 @@ Default values:
 
 ``` {.tex}
 \njustsetup{
+  logo = \njustwhole[njust][0.5], % depend on cnlogo
   cover-title = 毕业设计说明书,
   author = 佚名,
   id = 916101630000,
@@ -52,8 +66,12 @@ Default values:
   supervisor-title = 教授,
   associate-supervisor-title = 教授,
   judge-title = 教授,
-  year = \the\year,
+  year = \the\year, % the time of paper
   month = \the\month,
+  day = \the\day,
+  abstract-prefix = 毕业论文,
+  signature = ,
+  signature* = , % star means english
   abstract-prefix = 毕业论文,
   title* = ,
   subtitle* = ,
@@ -63,6 +81,49 @@ Default values:
 
 **Note**: Add curly brace around the string which contain ' ', '=', and ','.
 
+Usage
+-----
+
+Examples:
+
+```latex
+\documentclass{njustthesis}
+\njustsetup{%
+  author = 张不三,
+  id = 916101630000,
+  discipline = 电子信息工程,
+  title = {论文名字带逗号,或空格 },
+  subtitle = 所以加花括弧括起来,
+  title* = {English name},
+  supervisor = ,
+  supervisor-title = 教授,
+  judge = ,
+  % signature = \includegraphics{signature}, % if you have signature.pdf
+  judge-title = 教授,
+}
+\usepackage{subfiles}
+\begin{document}
+
+\maketitle
+
+\frontmatter
+\tableofcontents
+\listoffigures
+\listoftables
+
+\mainmatter% body
+% \subfile{subfiles/chapter1.tex} % make sure subfiles/chapter1.tex exist
+
+\backmatter%
+% \bibliography{refer.bib} % if you have references, you can export bib file
+% from google scholar, etc.
+
+\end{document}
+```
+
+More examples can see my homework.
+All my homework are write with this package.
+
 ## Todo ##
 
 Support [pandoc](https://github.com/jgm/pandoc).