Elaborated on what the root project can/should do.

This commit is contained in:
JesseBrault0709 2024-05-13 10:56:41 +02:00
parent 96d5d59df7
commit 597310f031

View File

@ -1,23 +1,28 @@
# Targeting 0.4.0: Ideas and Plans # Targeting 0.4.0: Ideas and Plans
- Have the following layout of dirs and files. It is a combined gradle/ssg project. Have the following layout of dirs and files. It is a combined gradle/ssg project.
- bin: a folder for shell scripts - bin: a folder for shell scripts
- ssg: a shell script to invoke the ssg-cli - ssg: a shell script to invoke the ssg-cli
- pages: a source set for pages - pages: a source set for pages
- groovy - groovy
- wvc - wvc
- gst - gst
- parts: a source set for parts/components - parts: a source set for parts/components
- groovy - groovy
- wvc - wvc
- gst - gst
- ssg: the folder for the build logic - src: a source set for the main/root project which can be depended upon by everything else. Useful for models, etc.
- groovy
- java
- resources
- ssg: the folder for the build logic
- buildSrc: a gradle subproject where we can put custom build logic that is accessible from scripts. - buildSrc: a gradle subproject where we can put custom build logic that is accessible from scripts.
- src - src
- groovy - groovy
- default.ssg.groovy: the 'default' build, which production/preview/etc. can extend
- build.gradle - build.gradle
- production.ssg.groovy: a 'production' build - production.ssg.groovy: a 'production' build
- preview.ssg.groovy: a 'preview' build - preview.ssg.groovy: a 'preview' build
- texts: a general folder for texts and other textual data, can be .md, .txt, .html, etc. - texts: a general folder for texts and other textual data, can be .md, .txt, .html, etc.
- build.gradle: the root project build.gradle - build.gradle: the root project build.gradle
- settings.gradle: the usual gradle settings - settings.gradle: the usual gradle settings