mirror of
https://github.com/ziglang/zig.git
synced 2026-01-10 17:35:12 +00:00
1116d88196
This commit introduces a new flag to generate a new Zig project using `zig init` without comments for users who are already familiar with the Zig build system. Additionally, the generated files are now different. Previously we would generate a set of files that defined a static library and an executable, which real-life experience has shown to cause confusion to newcomers. The new template generates one Zig module and one executable both in order to accommodate the two most common use cases, but also to suggest that a library could use a CLI tool (e.g. a parser library could use a CLI tool that provides syntax checking) and vice-versa a CLI tool might want to expose its core functionality as a Zig module. All references to C interoperability are removed from the template under the assumption that if you're tall enough to do C interop, you're also tall enough to find your way around the build system. Experienced users will still be able to use the current template and adapt it with minimal changes in order to perform more advanced operations. As an example, one only needs to change `b.addExecutable` to `b.addLibrary` to switch from generating an executable to a dynamic (or static) library.
82 lines
4.2 KiB
Zig
82 lines
4.2 KiB
Zig
.{
|
|
// This is the default name used by packages depending on this one. For
|
|
// example, when a user runs `zig fetch --save <url>`, this field is used
|
|
// as the key in the `dependencies` table. Although the user can choose a
|
|
// different name, most users will stick with this provided value.
|
|
//
|
|
// It is redundant to include "zig" in this name because it is already
|
|
// within the Zig package namespace.
|
|
.name = .LITNAME,
|
|
// This is a [Semantic Version](https://semver.org/).
|
|
// In a future version of Zig it will be used for package deduplication.
|
|
.version = "0.0.0",
|
|
// Together with name, this represents a globally unique package
|
|
// identifier. This field is generated by the Zig toolchain when the
|
|
// package is first created, and then *never changes*. This allows
|
|
// unambiguous detection of one package being an updated version of
|
|
// another.
|
|
//
|
|
// When forking a Zig project, this id should be regenerated (delete the
|
|
// field and run `zig build`) if the upstream project is still maintained.
|
|
// Otherwise, the fork is *hostile*, attempting to take control over the
|
|
// original project's identity. Thus it is recommended to leave the comment
|
|
// on the following line intact, so that it shows up in code reviews that
|
|
// modify the field.
|
|
.fingerprint = .FINGERPRINT, // Changing this has security and trust implications.
|
|
// Tracks the earliest Zig version that the package considers to be a
|
|
// supported use case.
|
|
.minimum_zig_version = ".ZIGVER",
|
|
// This field is optional.
|
|
// Each dependency must either provide a `url` and `hash`, or a `path`.
|
|
// `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
|
|
// Once all dependencies are fetched, `zig build` no longer requires
|
|
// internet connectivity.
|
|
.dependencies = .{
|
|
// See `zig fetch --save <url>` for a command-line interface for adding dependencies.
|
|
//.example = .{
|
|
// // When updating this field to a new URL, be sure to delete the corresponding
|
|
// // `hash`, otherwise you are communicating that you expect to find the old hash at
|
|
// // the new URL. If the contents of a URL change this will result in a hash mismatch
|
|
// // which will prevent zig from using it.
|
|
// .url = "https://example.com/foo.tar.gz",
|
|
//
|
|
// // This is computed from the file contents of the directory of files that is
|
|
// // obtained after fetching `url` and applying the inclusion rules given by
|
|
// // `paths`.
|
|
// //
|
|
// // This field is the source of truth; packages do not come from a `url`; they
|
|
// // come from a `hash`. `url` is just one of many possible mirrors for how to
|
|
// // obtain a package matching this `hash`.
|
|
// //
|
|
// // Uses the [multihash](https://multiformats.io/multihash/) format.
|
|
// .hash = "...",
|
|
//
|
|
// // When this is provided, the package is found in a directory relative to the
|
|
// // build root. In this case the package's hash is irrelevant and therefore not
|
|
// // computed. This field and `url` are mutually exclusive.
|
|
// .path = "foo",
|
|
//
|
|
// // When this is set to `true`, a package is declared to be lazily
|
|
// // fetched. This makes the dependency only get fetched if it is
|
|
// // actually used.
|
|
// .lazy = false,
|
|
//},
|
|
},
|
|
// Specifies the set of files and directories that are included in this package.
|
|
// Only files and directories listed here are included in the `hash` that
|
|
// is computed for this package. Only files listed here will remain on disk
|
|
// when using the zig package manager. As a rule of thumb, one should list
|
|
// files required for compilation plus any license(s).
|
|
// Paths are relative to the build root. Use the empty string (`""`) to refer to
|
|
// the build root itself.
|
|
// A directory listed here means that all files within, recursively, are included.
|
|
.paths = .{
|
|
"build.zig",
|
|
"build.zig.zon",
|
|
"src",
|
|
// For example...
|
|
//"LICENSE",
|
|
//"README.md",
|
|
},
|
|
}
|