Improve comments in Nutfile template for clarity and consistency

This commit is contained in:
Chipperfluff 2026-04-03 15:28:03 +02:00
parent f98844efaa
commit a9912c1ccf

View File

@ -1,12 +1,19 @@
# Example Nutfile for a simple project.
# This file was generated by Nut and can be edited to customize the build process.
# For more information on the Nutfile format and available options, see the documentation:
# https://nut.chipperfluff.at/docs/nutfile
# (Note: The documentation server does not exist yet, but it will be available in the future.)
# (no lol)
build: build:
# name of the resulting build # Name of the resulting build artifact.
# Example Build will become example_build.nut # "Example Build" becomes "example_build.nut".
name: Example Build name: Example Build
# name of the folder where the build will be outputted # Folder used for build output (temporary files + final artifacts).
# build procces will create this folder if it doesn't exist # Created automatically if it does not exist.
# its used for build process and the final files will be outputted in this folder
buildFolder: build buildFolder: build
# path to the entry point of the project, this is the file that will be executed when the build is run # Project entry file (relative to this Nutfile).
# Execution starts from this file in the built output.
entry: src/main.nut entry: src/main.nut