147971ddc7
Updates the `go run` command in the README to reflect the project's main entry point. Refines the TECH_STACK documentation by reordering and updating entries, and adds a note about embedding files in the binary.
37 lines
659 B
Markdown
37 lines
659 B
Markdown
# WhspBrd
|
|
|
|
- Run main loop, for now
|
|
|
|
```shell
|
|
go run cmd/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
|
|
```
|