Add README.

1 files changed, 75 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fcc59df
--- /dev/null
+++ b/README.md
@@ -0,0 +1,75 @@
+# hugo-theme-diary
+![](https://img.shields.io/badge/license-MIT-blue.svg)
+
+Original Author: [SumiMakito](https://github.com/SumiMakito)
+
+隻言片語・於此匯聚
+
+Moments piled up.
+---
+
+A Hugo theme ported from [SumiMakito/hexo-theme-Journal](https://github.com/SumiMakito/hexo-theme-Journal/).
+
+Hereinafter referred to the original version made by SumiMakito as `the ori`.
+
+This theme is [under construction](https://github.com/AmazingRise/hugo-theme-diary/projects/2).
+
+## Screenshots
+
+![](arts/main.png)
+Site Main Page
+
+![](arts/essay.png)
+An essay with picture.
+
+![](arts/m_main.png)
+Mobile Main Page
+
+## Features
+
+Features in the ori.:
+
+- Simple and easy to customize
+- Concentrated on reading <del>and writing (find a Markdown editor then)</del> experience
+- Mobile-friendly & widescreen-friendly
+- Flexible commenting control
+
+Features in this ported version:
+
+- Add support for gitalk.
+- Tag & category page appending more easily.
+- Customizable color scheme. (Some bug in original version, fixed.)
+- Firefox-friendly. (CSS issue in original version, fixed.)
+- `featured_image` url bug is fixed.
+
+## Quick Start
+
+If your website is using Git as version control, please do as follows:
+
+1. Fetch the theme dir.
+
+From the root of your Hugo site, open the terminal and execute:
+```bash
+git submodule add https://github.com/AmazingRise/hugo-theme-diary.git themes/diary
+```
+2. Update git repository.
+
+Then update the git repository from the root of your site:
+```bash
+git submodule update --remote --merge
+```
+
+3. Run example site.
+
+From the root of themes/diary/exampleSite:
+```bash
+hugo server --themesDir ../..
+```
+
+## Customize
+
+For customization, please visit [the project wiki](https://github.com/amazingrise/hugo-theme-diary/wiki) for details.
+
+## Comparison
+
+For details about the difference lies in the new version, please click [here.](https://github.com/AmazingRise/hugo-theme-diary/wiki/Comparison)
\ No newline at end of file