From 1344bd409111dd81e49e484542e494980a281671 Mon Sep 17 00:00:00 2001
From: Dmitriy Ryajov <dryajov@gmail.com>
Date: Tue, 10 May 2022 09:28:49 -0600
Subject: [PATCH] adding paper summaries (#68)

---
 papers/README.md   | 34 ++++++++++++++++++++++++++++++++++
 papers/template.md | 31 +++++++++++++++++++++++++++++++
 2 files changed, 65 insertions(+)
 create mode 100644 papers/README.md
 create mode 100644 papers/template.md

diff --git a/papers/README.md b/papers/README.md
new file mode 100644
index 0000000..f4047c1
--- /dev/null
+++ b/papers/README.md
@@ -0,0 +1,34 @@
+# Paper Summaries
+
+> This directory contains academic paper summaries explored as part of the Codex project research. It is structured as a list of links to a document containing a quick summary and observations extracted from the paper. The summaries aren't meant to be exhaustive and cover all aspects of the paper but rather serve as a quick refresher and a record of the papers already evaluated.
+
+## Index
+
+- [Compact Proofs of Retrievability](./Compact_Proofs_of_Retrievability/README.md)
+
+## Writing Summaries
+
+A summary should contain a brief overview of the core ideas presented in the paper along with observations and notes.
+
+## Template
+
+A [template](template.md) is provided that outlines a few sections:
+
+- Title - the title of the paper
+- Authors - the authors of the paper
+- DOI - the digital object identifier of the paper
+- Links - an optional section with links to the paper and other relevant material, such as source code, simulations, etc... If the paper is uploaded to the repo, it should be linked here as well.
+- Summary - a quick summary capturing the main ideas proposed by the paper
+- Main ideas - an optional list of bullet points describing the main ideas of the paper in more detail
+- Observations - an optional list of bullet pints with observations if any
+- Other ideas - an optional list of bullet points with additional observations
+
+## Directory Structure
+
+Each evaluation should go into it's own directory named after the paper being evaluated. It should contain a `README.md` with the actual evaluation and additional supporting material such as the paper itself, if one is available; or relevant code samples if those are provided. For example, the `Shacham and Waters - Compact Proofs of Retrievability` directory structure would look something like this:
+
+```
+├── Compact\ Proofs\ of\ Retrievability
+│   └── README.md
+|   └── Compact\ Proofs\ of\ Retrievability.pdf
+```
diff --git a/papers/template.md b/papers/template.md
new file mode 100644
index 0000000..3814ef0
--- /dev/null
+++ b/papers/template.md
@@ -0,0 +1,31 @@
+# Title
+
+The title of the paper
+
+## Authors
+
+The authors of the paper
+
+### DOI
+
+The digital object identifier for the paper
+
+### Links
+
+An optional section with links to the paper and other relevant material, such as source code, simulations, etc... If the paper is uploaded to the repo, it should be linked here as well.
+
+## Summary
+
+A quick summary capturing the main ideas proposed by the paper
+
+### Main ideas
+
+A list of bullet points describing the main ideas of the paper in more detail
+
+### Observations
+
+An optional list of bullet points with observations if any
+
+### Other ideas
+
+An optional list of bullet points with additional observations