Commit Graph

68 Commits

Author SHA1 Message Date
Chris Waldon 6d925a12ff doc: update readme with tag policy
This commit adds a note describing our tagged-version policy to the README.

Signed-off-by: Chris Waldon <christopher.waldon.dev@gmail.com>
2023-07-01 12:38:39 -04:00
Elias Naur bb56b8183c README.md: make the gioui.org link more prominent
The README is deliberately light; we want users to use the gioui.org site for
resources, not the site that happens to host the project Git repository.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2021-02-01 17:03:12 +01:00
Elias Naur f3ab8d6368 README.md: change GitHub mirror location
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2020-12-14 23:29:14 +01:00
Elias Naur 221ce02328 LICENSE: merge UNLICENSE and LICENSE-MIT
The pleasing of automatic license detectors continues.

No license change, merely a merging of LICENSE-MIT and UNLICENSE and the
license blurp from README.md.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2020-04-02 10:45:37 +02:00
Elias Naur 62a2f3b8c8 README.md: link to Larry's GitHub mirror
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2020-02-29 15:42:01 +01:00
Elias Naur 5406a13257 README.md: move COPYING license verbiage back to the README.md file
Now that pkg.go.dev supports the UNLICENSE, the COPYING file confuses
the automatic license detection. Move the license text back to README.md.

This is merely a cosmetic change, there are no licensing changes to
the project.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2020-02-25 12:13:24 +01:00
Elias Naur 359839ad07 README.md: add OpenBSD to list of supported platforms
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2020-02-01 15:56:50 +01:00
Elias Naur 19acf05820 COPYING: extract licensing information into COPYING
This is hopefully clear enough for license detectors and lawyers.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-12-18 09:58:21 +01:00
Elias Naur da42412e56 README.md: add an Oxford comma to emphasize only WebAssembly is
experimental

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-11-09 00:42:02 +01:00
Elias Naur 9def3153de README.md: note that the WebAssembly is experimental
It's slow and syscall/js has seen incompatible changes in Go 1.13
and Go 1.14.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-11-08 22:27:06 +01:00
Elias Naur 96072cec66 README.md: add note about gio-patches mailing list
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-11-06 16:41:13 +01:00
Elias Naur 7182477f3c README.md: add supported platforms
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-11-02 16:32:47 +01:00
Elias Naur 8fab2f8cb1 .builds: add automatic testing script
Add fedora.yml for testing on linux and windows.

Add android.yml for testing `gogio -target android`.

Add a build badge to the README.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-27 19:12:50 +01:00
Elias Naur f4c6ec4fbe README.md: add sr.ht related documentation from gioui.org
Use https for the Unlicense URL and add one for MIT as well.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-27 16:29:36 +01:00
Elias Naur ec672ca06a README.md: remove documentation and link to gioui.org
There is now a real website on gioui.org. Use that for documentation.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-26 21:43:49 +02:00
Elias Naur a21e8bf7e4 README.md: initialize a module before running module commands
Go 1.14 disables the use of `go run` in module mode outside a module,
see https://golang.org/issue/32027.

Suggest initializing a module in the current directory instead; that
enables module mode (in Go 1.13) and enables `go run`.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-10 08:43:48 +02:00
Elias Naur e031d7325c README.md: remove text about the gophers example -token flag
It doesn't belong in a README about Gio.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-09 17:44:04 +02:00
Elias Naur 38a5717216 README.md: update godoc link
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-06 17:18:40 +02:00
Elias Naur ea082c5cca example: rename apps module
The new name emphasize the nature of the programs and won't be
confused with package `app`.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-06 09:43:27 +02:00
Elias Naur 2a1c203863 README.md: link to Gophercon UK presentation recording
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-10-02 10:12:12 +02:00
Elias Naur a12912c944 cmd/gogio: rename the gio too to gogio
The `gio` name clashes with a widely deployed GNOME tool.
Rename our tool to `gogio`, "the go tool for gio programs".

Fixes gio#20

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-09-18 22:46:47 +02:00
Elias Naur 063b4a5659 README.md: suggest Go 1.13 now that it is released
Some platforms run on previous Go versions, but let's nudge people to use Go
1.13. Go 1.13 is required to build for WebAssembly and for running Go
binaries on the latest versions of Android, iOS, tvOS.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-09-03 22:52:26 +02:00
Kenshi Kamata 82b0563c8b README, ui/layout: fix typos
Signed-off-by: Kenshi Kamata <kenshi.kamata@gmail.com>
2019-09-03 19:26:00 +02:00
Elias Naur ff657fb476 README.md: fix link
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-09-03 18:34:49 +02:00
Elias Naur 7f29293f16 README.md: add donations section
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-08-30 14:39:21 +02:00
Elias Naur 41ea609d8e README.md: add link to Gophercon 2019 recording
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-08-27 15:59:09 +01:00
Elias Naur 9136c72425 README.md: add Gophercon UK 2019 talk
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-08-25 22:27:41 +01:00
Elias Naur 3099e7474f README.md: fix link
Thanks to Antonio D'souza for noticing.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-08-18 21:25:13 +02:00
Elias Naur 8c3305e88b README.md: add link to FAQ
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-08-05 16:13:54 +02:00
Elias Naur a27f12faf3 README.md: move license last, tweak text
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-08-05 15:55:47 +02:00
Elias Naur 9babb1389d README.md: split out installation, integration, contributing sections
Add them to the wiki so README.md ends up less overwhelming.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-08-05 15:50:39 +02:00
Larry Clapp 7f82b5d637 README.md: add backticks to giowindow div tag
Wrap backticks around the "div" tag mentioned in the README, so it looks
like this:

    `<div id="giowindow">`

Without the backticks, the markdown renderer renders it as an actual
<div> tag in the output html (without an ID, either).

Signed-off-by: Larry Clapp <larry@theclapp.org>
2019-08-04 20:52:36 +02:00
Elias Naur a2e485b56d README.md: add link to Gophercon 2019 talk
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-07-25 13:10:49 -07:00
Elias Naur 934aa4fe8d README.md: add shameless plug to Scatter
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-07-16 18:57:38 +02:00
Elias Naur 5b7a7334c8 README.md: update for -buildmode=exe default
Also, move the exe section to the beginning of the mobile sections,
leaving -buildmode=archive second.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-07-07 11:43:32 +02:00
Elias Naur 48786bbd05 README.md: move the build line first in webassembly instructions
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-07-07 00:11:38 +02:00
Elias Naur 535f61fbeb README.md: update mailing list name and fix todo address
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-06-18 17:41:41 +02:00
Elias Naur d142a8c89d README.md: use example.com instead of gmail.com for example
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-06-09 16:37:15 +02:00
Elias Naur cf99b9b487 README.md: describe how to run programs on iOS simulators
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-06-09 16:22:49 +02:00
Elias Naur 821862b4c6 README.md: use the -buildmode=exe flag for running demos
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-06-09 15:41:28 +02:00
Elias Naur 44e02786c6 README.md: note that todos can now be filed through email
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-05-15 22:48:05 +02:00
Elias Naur af7a0ad293 REEADME.md: fix typo
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-05-11 14:49:37 +02:00
Elias Naur 6d690fd343 README.md: add note about webassembly support
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-05-11 13:36:24 +02:00
Elias Naur d4ff577259 README.md: add download link to Go
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-04-07 18:27:53 +02:00
Elias Naur afa91ed942 README.md: note that the NVIDIA proprietary driver doesn't work
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-04-05 19:40:15 +02:00
Elias Naur b5d8e1cfe2 README.md: describe name and email configuration
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-04-05 11:27:17 +02:00
Elias Naur c20255335f README.md: point to git-send-email.io
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-04-05 11:10:07 +02:00
Elias Naur a876ce8a53 README.md: further clarify the mailing list description
Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-04-03 17:02:55 +02:00
Elias Naur 31e06bd931 README.md: note that the mailing list is open to everyone
A Sourcehut account is only required for subscribing to new posts.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-04-03 14:57:45 +02:00
Elias Naur fca780972a README.md: add note about commit message style
And move the issues section above the heavy contribution section
while we're here.

Signed-off-by: Elias Naur <mail@eliasnaur.com>
2019-04-03 12:19:16 +02:00