Add badge

adapt-sjtu · Dec 12, 2020 · 061d614 · 061d614
1 parent 0289cfe
commit 061d614
Show file tree

Hide file tree

Showing 7 changed files with 691 additions and 164 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-commonsense-papers.bib
+commonsense-papers.bib
+README.html
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,8 @@ Welcome to the `commonsense-papers` project. We aim to select the most represent
 
 Since our paper-list cannot be complete, we welcome your contributions. 
 
+The `README_edit.md` is the file for human to edit, and `README.md` should be automatically generated by `gen_badge.py`.
+
 ## Paper
 
 All the papers include here should follow the following format: 
@@ -28,6 +30,6 @@ If a paper does not fit into a current (sub)class, can add a new one.
 
 If a paper provides a resource as well as a method, we usually put it into the resource class.
 
-## Statistics
+## Statistics and Badges
 
-After editing the paper list with the format stated above, simply run `gen_stats.py` and the statistics in `README.md` will automatically update.
+After editing the paper list in `README_edit.md` with the format stated above, simply run `gen_badge.py` and the statistics in `README.md` will automatically update.
diff --git a/README.md b/README.md