From cb47bd2d38b28e56b2ff64e15c5090ab17011804 Mon Sep 17 00:00:00 2001
From: yupix <yupi0982@outlook.jp>
Date: Sun, 21 Jan 2024 22:06:46 +0900
Subject: [PATCH] docs: add README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f7de35a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# あゆき's BLOG
+
+@aki と @sousuke0422 による共同ブログです。
+このブログは Hugo を使用しています。 テーマは [hugo-theme-stack](https://github.com/CaiJimmy/hugo-theme-stack) を一部変更した上で使用しています。 
+実際に使用している[テンプレート](https://github.com/TeamBlackCrystal/hugo-theme-stack)
+
+## 動かし方・ビルド
+
+Hugoのインストール(scoop を使うことを想定しています)
+
+```bash
+# Windows
+scoop install hugo-extended
+```
+
+ローカル用のサーバーを起動する
+
+```bash
+hugo server
+```
+
+お試しビルドの方法
+
+```bash
+hugo
+```
+
+実行後に生成された `public` ディレクトリがビルド成果
+
+## 記事の追加方法
+
+> [!NOTE]
+> 記事の名前には英数記号のみがサポートされています。日本語はどうなるか分かりません。
+
+```bash
+python helper.py new <post name>
+```
+
+記事内の `draft = true` を `false` に変更すると表示されるようになります