some documentation changes
This commit is contained in:
@@ -27,3 +27,26 @@ Automated agents, bots, or autonomous AI systems _may not_ independently submit
|
||||
Project maintainers retain _full discretion_ to close pull requests and issues that appear to be low-quality AI-generated content.
|
||||
While we welcome new contributors, we want to see those that will engage constructively with the review process, rather than deferring
|
||||
to AI.
|
||||
|
||||
## Building Amsterdam
|
||||
|
||||
From the root of the source tree, just run `go build` to build the `amsterdam` executable.
|
||||
|
||||
To regenerate the `tailwind.css` file (located in `ui/static/css`), you will need the Tailwind CSS command-line executable.
|
||||
Download it from [the Tailwind GitHub](https://github.com/tailwindlabs/tailwindcss/releases/) and install it as `tailwindcss`
|
||||
in your `PATH`. Then run `go generate` to regenerate the CSS file before you run `go build` to build the executable.
|
||||
|
||||
## Dependencies
|
||||
|
||||
Dependencies are managed using [Go Modules](https://go.dev/cmd/go/#hdr-Module_maintenance).
|
||||
You can find more details in the [go mod documentation](https://go.dev/ref/mod) and the [Go Modules Wiki](https://github.com/golang/go/wiki/Modules).
|
||||
|
||||
Pull requests should only modify `go.mod` or `go.sum` where it is related to the change at hand, whether a bug fix or a new feature.
|
||||
Apart from that, these files should only be modified by pull requests whose only purpose is to update dependencies.
|
||||
|
||||
## Copyright
|
||||
|
||||
New code files should use one of the standard headers found in the `docs/templates` folder. Examples exist for Go (also works with CSS),
|
||||
HTML, Jet, and YAML (also works with SQL).
|
||||
|
||||
The copyright range should be updated when a file is modified in a year later than the current end of the range.
|
||||
|
||||
Reference in New Issue
Block a user