mvdan.cc / cue
this repo has no description
0
fork

Configure Feed

Select the types of activity you want to include in your feed.

README: clarify that source archive builds lack version info

https://cuelang.org/cl/1220488 dropped the README section
on the old ldflags version injection mechanism,
but we should have instead clarified that the new automatic mechanism
requires VCS information to be present for it to work at all.

Be clear that downstream packages should build from git tags,
as building from release archives without VCS info will
fail to properly stamp the binary with version info.

While here, a few drive-by improvements and cleanups:
* Mention XML, which is popular and we support now
* Remove a redundant sentence introducing install sub-sections
* Remove the "contributing" and "license" sections;
GitHub now renders clear tabs for those next to the README

For #4292.

Signed-off-by: Daniel Martí <mvdan@mvdan.cc>
Change-Id: I80664c59971e3b63e54139d6bd9724de9ccb3544
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1232684
TryBot-Result: CUEcueckoo <cueckoo@cuelang.org>
Reviewed-by: Paul Jolly <paul@myitcv.io>

Daniel Martí c19c1c46 310f61c3

+6 -12
+6 -12
README.md
··· 26 26 and ensure configurations align with policies. 27 27 28 28 CUE works with a wide range of tools and formats that you're already using 29 - such as Go, JSON, YAML, TOML, OpenAPI, Protobuf, and JSON Schema. 29 + such as Go, JSON, YAML, TOML, XML, OpenAPI, Protobuf, and JSON Schema. 30 30 31 31 For more information and documentation, including __tutorials and guides__, see [cuelang.org](https://cuelang.org). 32 32 ··· 35 35 The full range of installation methods for the `cue` command are listed on 36 36 [cuelang.org](https://cuelang.org/docs/introduction/installation/), 37 37 including the official container image suitable for use with Docker. 38 - Here are two common ways to install the command: 39 38 40 39 #### Release builds 41 40 ··· 47 46 48 47 go install cuelang.org/go/cmd/cue@latest 49 48 50 - You can also clone the repository and build it directly via `go install ./cmd/cue`. 49 + You can also `git clone` the repository and build it directly via `go install ./cmd/cue`. 50 + 51 + Built `cue` binaries include version information as reported by `cue version`, 52 + which `go build` derives from the VCS. We recommend that downstream packagers 53 + build releases from git tags rather than source archives to ensure this works. 51 54 52 55 ### Learning CUE 53 56 ··· 76 79 For example, if CUE v0.7.0 is released when Go's latest version is 1.21.5, 77 80 v0.7.x including any following bugfix releases will require Go 1.20 or later. 78 81 79 - ### Contributing 80 - 81 - To contribute, please read the [Contribution Guide](CONTRIBUTING.md). 82 - 83 82 ## Code of Conduct 84 83 85 84 Guidelines for participating in CUE community spaces and a reporting process for ··· 90 89 - Ask questions via [GitHub Discussions](https://github.com/cue-lang/cue/discussions) 91 90 - Chat with us on [Slack](https://cuelang.org/s/slack) and [Discord](https://cuelang.org/s/discord) 92 91 - Subscribe to our [Community Calendar](https://cuelang.org/s/community-calendar) for community updates, demos, office hours, etc 93 - 94 - --- 95 - 96 - Unless otherwise noted, the CUE source files are distributed 97 - under the Apache 2.0 license found in the LICENSE file.