WhspBrd/README.md
2025-06-02 19:01:07 +02:00

37 lines
663 B
Markdown

# WhspBrd
- Run main loop, for now
```shell
go run cmd/tui/main.go
```
## File structure
- may be edited in accordance with [this project standard](https://github.com/golang-standards/project-layout)
### pkg
- reusable modules in other projects and used imports, like image manipulation, systray configuration etc...
### cmd
- entrypoint for our application with main.go
### internal
- code that is not reusable and we don't want to share it with others, maybe parts of code in cmd will be moved here instead
- tui and cli logic
### configs
- example of configuration
### vendor
- localy downloaded libraries and imports
```shell
go mod vendor
```