Add generator as git submodule to current project

andrei-punko · andrei-punko · commit c7bb787cf67c · 2022-10-04T20:33:36.000+03:00
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "github-pages-content-generator"]
+	path = github-pages-content-generator
+	url = https://github.com/andrei-punko/github-pages-content-generator
diff --git a/README.md b/README.md
@@ -1,19 +1,26 @@
-## Java interview questions and answers
 
-### Link to generated site:
+# Java interview questions and answers
 
+## Link to generated site:
 https://andrei-punko.github.io/java-interview-faq-n-answers
 
-### Update instructions:
-- Modify [content.txt](content.txt) if needed
-- Modify [template.html](template.html) if needed
-- Run [generate.bat](generate.bat)
-- Commit changes to repo
+## Prerequisites
+- JDK 11
+- Maven 3
 
-Instead 2 last steps you could use [generate-n-commit-n-push.bat](generate-n-commit-n-push.bat)
+## Generator and its preparation
+[Generator](https://github.com/andrei-punko/github-pages-content-generator) to create a site 
+by content from text file using templates added as Git submodule to current project
 
-### Sources of generator to create a site by content from text file using template placed here:
+To build generator - run next command from `github-pages-content-generator` folder:
+```
+mvn clean install
+```
 
-https://github.com/andrei-punko/github-pages-content-generator
+## Update instructions
+- Modify [content.txt](src/content.txt) if needed
+- Modify [template.html](templates/template.html) if needed
+- Run [generate.bat](generate.bat)
+- Commit changes to repo
 
-If needed - change generator logic, build jar-file and replace existing [github-pages-content-generator.jar](github-pages-content-generator.jar)
+Instead of two last steps could use [generate-n-commit-n-push.bat](generate-n-commit-n-push.bat) script
diff --git a/bin/github-pages-content-generator.jar b/bin/github-pages-content-generator.jar
diff --git a/generate.bat b/generate.bat
@@ -1,4 +1,4 @@
 
 del *.html
 
-java -jar bin/github-pages-content-generator.jar src/content.txt templates/template.html index.html
+java -jar github-pages-content-generator/target/github-pages-content-generator.jar src/content.txt templates/template.html index.html
diff --git a/github-pages-content-generator b/github-pages-content-generator
@@ -0,0 +1 @@
+Subproject commit dc9fc88262220946580d52c4e954c0232932ac70

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[submodule "github-pages-content-generator"]`
	`2`	`+ path = github-pages-content-generator`
	`3`	`+ url = https://github.com/andrei-punko/github-pages-content-generator`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`
`2`	`2`	`del *.html`
`3`	`3`
`4`		`-java -jar bin/github-pages-content-generator.jar src/content.txt templates/template.html index.html`
	`4`	`+java -jar github-pages-content-generator/target/github-pages-content-generator.jar src/content.txt templates/template.html index.html`