docs: bring README.md in line with Standard Readme
This commit is contained in:
parent
1ed566665a
commit
7e6d773813
1 changed files with 25 additions and 1 deletions
26
README.md
26
README.md
|
|
@ -1,6 +1,8 @@
|
||||||
# UI-Docs
|
# UI-Docs
|
||||||
|
|
||||||
Walkthrough screenshots, usage instructions, and a review PDF for every operator, staff, portal, admin, simulator, and catalog surface in the Verae Time × Zapier lab.
|
[](https://github.com/RichardLitt/standard-readme)
|
||||||
|
|
||||||
|
Walkthrough screenshots, usage instructions, and a review PDF for every operator, staff, portal, admin, simulator,...
|
||||||
|
|
||||||
**Forgejo:** https://git.georgelambert.org/marchon/UI-Docs
|
**Forgejo:** https://git.georgelambert.org/marchon/UI-Docs
|
||||||
|
|
||||||
|
|
@ -22,3 +24,25 @@ npm run pdf # reportlab → UI-REVIEW.pdf
|
||||||
```
|
```
|
||||||
|
|
||||||
Chrome path: `CHROME_PATH` or `/Applications/Google Chrome.app/Contents/MacOS/Google Chrome`.
|
Chrome path: `CHROME_PATH` or `/Applications/Google Chrome.app/Contents/MacOS/Google Chrome`.
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
git clone ssh://git@git.georgelambert.org:2223/marchon/UI-Docs.git
|
||||||
|
cd UI-Docs
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# No single entrypoint is declared in this tree.
|
||||||
|
ls
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Questions: open an issue at https://git.georgelambert.org/marchon/UI-Docs/issues. Pull requests are accepted.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
UNLICENSED © George Lambert
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue