Documented how to check local operation

Author: koron

Makefile

@@ -3,6 +3,10 @@
 JEKYLL_WORKDIR=target/jekyll-work
 JEKYLL_OUTDIR=target/_site
 
+all:
+	$(MAKE) html
+	$(MAKE) jekyl-build-by-docker
+
 html-prepare: vim/runtime/doc vim_faq/doc target/html/doc
 	rm -f target/html/doc/*.txt
 	cp vim/runtime/doc/*.txt target/html/doc
@@ -24,7 +28,7 @@ target/html/doc:
 clean:
 	rm -rf target
 
-distclean:
+distclean: clean
 	rm -rf vim vim_faq
 
 jekyll-build-prepare:

README.md

@@ -6,3 +6,16 @@ There is already another similar site: <https://vimhelp.org/>.
 The main purpose of the vimdoc-en project is to provide a handy way to see both Japanese and English versions of the help pages.
 
 The help pages are automatically updated everyday (if there are any changes).
+
+## for Developers
+
+First of all, to generate everything, just run `make`.
+This requires Docker, so prepare it in advance.
+
+Here's what's happening:
+
+1. Run `make html` to generate HTML files before GitHub Pages (Jekyll) processing
+    1. Download vim and vim\_faq
+    2. Collect the necessary \*.txt files
+    3. Convert the \*.txt files to \*.html
+2. Run `make jekyll-build-by-docker` to output all HTML files for the vimdoc-en site using GitHub Pages (Jekyll)