You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-8Lines changed: 36 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -287,12 +287,40 @@ See [CONTRIBUTING.md](./CONTRIBUTING.md)
287
287
288
288
## Local development
289
289
290
-
To build locally:
291
-
```
292
-
make build
293
-
```
290
+
This project uses [mise-en-place](https://mise.jdx.dev/) for development environment management. Mise automatically manages Go versions and development tools.
294
291
295
-
To run tests locally:
296
-
```
297
-
make test
298
-
```
292
+
### Prerequisites
293
+
294
+
1. Install mise-en-place:
295
+
```shell
296
+
# macOS
297
+
brew install mise
298
+
299
+
# Or using curl
300
+
curl https://mise.run | sh
301
+
```
302
+
303
+
2. Install the GitHub CLI:
304
+
```shell
305
+
brew install gh
306
+
```
307
+
308
+
### Getting Started
309
+
310
+
1. Clone the repository and navigate to the project directory
311
+
2. Run `mise install` to install the required Go version and tools (defined in `.mise.toml`)
312
+
3. Run `mise run dev` to set up the development environment
313
+
4. Use mise tasks with `mise run <task>` to perform development operations
314
+
315
+
### Available Development Tasks
316
+
317
+
-`mise run mod` - Download and tidy Go modules
318
+
-`mise run lint` - Run linting
319
+
-`mise run fix` - Auto-fix linting issues
320
+
-`mise run build` - Build the application
321
+
-`mise run install` - Install the application locally
322
+
-`mise run test` - Run tests
323
+
-`mise run clean` - Clean build artifacts
324
+
-`mise run dev` - Run development setup
325
+
326
+
All tools and dependencies are automatically managed by mise-en-place based on the `.mise.toml` configuration.
0 commit comments