Improve comments in Nutfile template for clarity and consistency
This commit is contained in:
parent
f98844efaa
commit
a9912c1ccf
@ -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:
|
||||
# name of the resulting build
|
||||
# Example Build will become example_build.nut
|
||||
# Name of the resulting build artifact.
|
||||
# "Example Build" becomes "example_build.nut".
|
||||
name: Example Build
|
||||
|
||||
# name of the folder where the build will be outputted
|
||||
# build procces will create this folder if it doesn't exist
|
||||
# its used for build process and the final files will be outputted in this folder
|
||||
# Folder used for build output (temporary files + final artifacts).
|
||||
# Created automatically if it does not exist.
|
||||
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
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user