README tweaks

This commit is contained in:
Max Howell 2023-04-25 08:53:08 -04:00
parent 35a58786fb
commit 4237766daa
No known key found for this signature in database
GPG key ID: 741BB84EF5BB9EEC

View file

@ -12,32 +12,31 @@
</a>
</p>
This repository contains tea/gui \[[notion]\].
The Open Store.
# Developing tea/gui
# Developing `tea/gui`
To develop within an electron view:
To develop within an Electron view:
```
$ xc build
# ^^ not always required
$ xc setup
$ xc dev
```sh
xc setup # only required once
xc build # only required if you modify the backend
xc dev # opens the app in dev mode
```
# Contributing to tea/gui
# Contributing to `tea/gui`
If you have suggestions or ideas, start a [discussion]. If we agree, well move it to an issue. Bug fixes straight to pull request or issue please!
# Releasing tea/gui
# Releasing `tea/gui`
Tag any commit in the main branch, then push directly to the main branch.
Lets follow the [semver] versioning standard, prefixed with `v`:
```
$ git tag v1.0.0
$ git push <remote> tag v1.0.0
$ git push origin tag v1.0.0
```
Refer to each package `README.md` for instructions on how to setup and