63 lines
1.0 KiB
Markdown
63 lines
1.0 KiB
Markdown
# DanceLessonsCoach
|
|
|
|
A simple Go project demonstrating idiomatic package structure and CLI implementation.
|
|
|
|
## Features
|
|
|
|
- Greet function with default behavior
|
|
- Command-line interface
|
|
- Unit tests
|
|
- Go 1.26.1 compatible
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
# Clone the repository
|
|
git clone https://github.com/yourusername/DanceLessonsCoach.git
|
|
cd DanceLessonsCoach
|
|
|
|
# Build and run
|
|
go run ./cmd/greet
|
|
```
|
|
|
|
## Usage
|
|
|
|
```bash
|
|
# Default greeting
|
|
go run ./cmd/greet
|
|
# Output: Hello world!
|
|
|
|
# Custom greeting
|
|
go run ./cmd/greet John
|
|
# Output: Hello John!
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
# Run all tests
|
|
go test ./...
|
|
|
|
# Run specific package tests
|
|
go test ./pkg/greet/
|
|
```
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
DanceLessonsCoach/
|
|
├── cmd/
|
|
│ └── greet/
|
|
│ └── main.go # CLI entry point
|
|
├── pkg/
|
|
│ └── greet/
|
|
│ ├── greet.go # Core library
|
|
│ └── greet_test.go # Unit tests
|
|
├── go.mod # Go module definition
|
|
└── README.md # Project documentation
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|