diff --git a/README.md b/README.md index 7cab640..eee5898 100644 --- a/README.md +++ b/README.md @@ -1 +1,23 @@ -# Linux0.01_redocument \ No newline at end of file +# Linux0.01_redocument + +このリポジトリは、Linux 0.01のソースコードを再ドキュメント化した内容をQiitaに掲載するためのマークダウンファイルを管理するためのものです。 + +## ディレクトリ構成 + +``` +. +├── README.md +└── articles/ # Qiita記事用マークダウンファイル + └── .gitkeep +``` + +## 記事の書き方 + +1. `articles/` ディレクトリに新しいマークダウンファイルを作成 +2. ファイル名は内容がわかりやすい名前をつける(例: `boot-process.md`) +3. Qiitaのマークダウン形式に従って記事を作成 + +## 参考リンク + +- [Qiita Markdown記法](https://qiita.com/Qiita/items/c686397e4a0f4f11683d) +- [Linux 0.01 ソースコード](https://mirrors.edge.kernel.org/pub/linux/kernel/Historic/) \ No newline at end of file diff --git a/articles/.gitkeep b/articles/.gitkeep new file mode 100644 index 0000000..527ae53 --- /dev/null +++ b/articles/.gitkeep @@ -0,0 +1,2 @@ +# This file is used to keep the articles directory in git +# You can delete this file once you add actual markdown files