Skip to content

Commit f0c3e21

Browse files
committed
modified: releasr names
1 parent fb870e6 commit f0c3e21

File tree

2 files changed

+34
-42
lines changed

2 files changed

+34
-42
lines changed

.goreleaser.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ builds:
1212
- darwin
1313
- windows
1414
goarch:
15-
- amd64
15+
- amd64 # Renamed to x86_64 in outputs
1616
- arm64
1717
- "386"
1818
main: ./main.go
19-
binary: "go-typer-{{ .Version }}-{{ .Os }}-{{ .Arch }}"
19+
binary: "go-typer-{{ .Version }}-{{ replace .Os `darwin` `macOS` }}-{{ if eq .Os `darwin` }}{{ if eq .Arch `arm64` }}apple-silicon{{ else }}intel{{ end }}{{ else }}{{ replace (replace .Arch `amd64` `x86_64`) `386` `i386` }}{{ end }}"
2020
ldflags:
2121
- -s -w -X main.version={{.Version}} -X main.commit={{.Commit}} -X main.date={{.Date}}
2222
ignore:
@@ -25,7 +25,7 @@ builds:
2525

2626
archives:
2727
- format: tar.gz
28-
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}"
28+
name_template: "{{ .ProjectName }}_{{ .Version }}_{{ replace .Os `darwin` `macOS` }}_{{ if eq .Os `darwin` }}{{ if eq .Arch `arm64` }}apple-silicon{{ else }}intel{{ end }}{{ else }}{{ replace (replace .Arch `amd64` `x86_64`) `386` `i386` }}{{ end }}"
2929
format_overrides:
3030
- goos: windows
3131
format: zip

README.md

Lines changed: 31 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
1-
21
# 🚀 Go Typer
32

43
**The sleek, fast terminal typing game inspired by [MonkeyType](https://monkeytype.com/)!**
54

65
Go Typer brings the popular web-based typing experience of MonkeyType to your terminal with a beautiful, customizable interface. Master your typing skills right in your terminal (where it actually matters 😉) without a browser.
76
(online multiplayer type racer, coming soon)
87

9-
108
## 🛠️ Built With
119

1210
[![Go](https://img.shields.io/badge/Go-00ADD8?style=flat-square&logo=go&logoColor=white)](https://go.dev/) [![Cobra](https://img.shields.io/badge/Cobra-00ADD8?style=flat-square&logo=go&logoColor=white)](https://github.com/spf13/cobra) [![Bubble Tea](https://img.shields.io/badge/Bubble%20Tea-FF75B7?style=flat-square&logo=go&logoColor=white)](https://github.com/charmbracelet/bubbletea) [![Lip Gloss](https://img.shields.io/badge/Lip%20Gloss-FFABE7?style=flat-square&logo=go&logoColor=white)](https://github.com/charmbracelet/lipgloss)
1311

14-
1512
<h2><sub> 📷 </sub> Screenshots</h2>
1613
<table align="center">
1714
<tr>
@@ -48,7 +45,7 @@ Verify your terminal supports TrueColor by running:
4845

4946
```bash
5047
printf "\x1b[38;2;255;0;0mTRUECOLOR\x1b[0m\n"
51-
````
48+
```
5249

5350
If you see "TRUECOLOR" in red, you're good to go\! If not, check out [this compatibility guide](https://gist.github.com/weimeng23/60b51b30eb758bd7a2a648436da1e562).
5451

@@ -67,29 +64,29 @@ Choose the installation method that suits you best:
6764

6865
Download the latest pre-built binaries for your operating system from the [Releases](https://github.com/prime-run/go-typer/releases) page. Here's a simplified way to download and install (rootless):
6966

70-
**Linux (x86\_64):**
67+
**Linux (x86_64):**
7168

72-
```bash
69+
```bash
7370
wget https://github.com/prime-run/go-typer/releases/download/v1.0.1/go-typer_1.0.1_linux_amd64.tar.gz
7471
mkdir -p ~/.local/bin
7572
tar -xzf go-typer_*.tar.gz -C ~/.local/bin go-typer
76-
```
73+
```
7774

78-
**macOS (Intel x86\_64):**
75+
**macOS (Intel x86_64):**
7976

80-
```bash
77+
```bash
8178
wget https://github.com/prime-run/go-typer/releases/download/v1.0.1/go-typer_1.0.1_darwin_amd64.tar.gz
8279
mkdir -p ~/.local/bin
8380
tar -xzf go-typer_*.tar.gz -C ~/.local/bin go-typer
84-
```
81+
```
8582

8683
**macOS (Apple Silicon arm64):**
8784

88-
```bash
85+
```bash
8986
wget https://github.com/prime-run/go-typer/releases/download/v1.0.1/go-typer_1.0.1_darwin_arm64.tar.gz
9087
mkdir -p ~/.local/bin
9188
tar -xzf go-typer_*.tar.gz -C ~/.local/bin go-typer
92-
```
89+
```
9390

9491
After downloading and extracting, ensure that `~/.local/bin` is in your system's `PATH` environment variable. You can usually do this by adding the following line to your shell's configuration file (e.g., `.bashrc`, `.zshrc`):
9592

@@ -113,8 +110,7 @@ Now you should be able to run Go Typer by simply typing `go-typer` in your termi
113110
<summary><b>⚙️ Go Install (For Go Users)</b></summary>
114111

115112
> [!NOTE]
116-
> [go](https://go.dev/doc/install) version > v1.24 is required
117-
113+
> [go](https://go.dev/doc/install) version > v1.24 is required
118114
119115
```bash
120116
go install github.com/prime-run/go-typer@latest
@@ -159,8 +155,6 @@ docker run -it --rm go-typer
159155

160156
</details>
161157

162-
163-
164158
## 🎮 How to Play
165159

166160
1. Launch Go Typer:
@@ -183,43 +177,41 @@ docker run -it --rm go-typer
183177

184178
### 🎯 Keyboard Controls
185179

186-
- **↑/↓ or j/k**: Navigate through menu items
187-
- **Enter**: Select menu item
188-
- **Esc**: Go back to the previous screen
189-
- **Space**: Advance to the next word while typing
190-
- **Tab**: Restart the current typing exercise
191-
- **q or Ctrl+C**: Quit the application
180+
- **↑/↓ or j/k**: Navigate through menu items
181+
- **Enter**: Select menu item
182+
- **Esc**: Go back to the previous screen
183+
- **Space**: Advance to the next word while typing
184+
- **Tab**: Restart the current typing exercise
185+
- **q or Ctrl+C**: Quit the application
192186

193187
## ⚙️ Configuration
194188

195189
Go Typer automatically saves your preferences in your user config directory:
196190

197-
198-
- Linux/BSD: `~/.config/go-typer/settings.json`
199-
- macOS: `~/Library/Application Support/go-typer/settings.json`
200-
- Windows: `%AppData%\go-typer\settings.json`
191+
- Linux/BSD: `~/.config/go-typer/settings.json`
192+
- macOS: `~/Library/Application Support/go-typer/settings.json`
193+
- Windows: `%AppData%\go-typer\settings.json`
201194

202195
![image](https://github.com/user-attachments/assets/fec6e04c-57d7-4d63-ae24-fc9dff73d923)
203196

204-
205197
You can directly edit the `settings.json` file to customize the following options:
206198

207-
- **theme**: Pick from eye-catching color schemes (`default`, `dark`, `monochrome`) or create your own.
208-
- **cursor\_style**: Choose between `block` or `underline`.
209-
- **game\_mode**: Select `normal` (with punctuation) or `simple` for beginners.
210-
- **include\_numbers**: Set to `true` to include numbers in typing tests.
211-
- **text\_length**: Choose from `short`, `medium`, `long`, or `very_long`.
212-
- **refresh\_rate**: Fine-tune animation smoothness from `5` (battery-saving) to `60` (ultra-smooth) FPS.
199+
- **theme**: Pick from eye-catching color schemes (`default`, `dark`, `monochrome`) or create your own.
200+
- **cursor_style**: Choose between `block` or `underline`.
201+
- **game_mode**: Select `normal` (with punctuation) or `simple` for beginners.
202+
- **include_numbers**: Set to `true` to include numbers in typing tests.
203+
- **text_length**: Choose from `short`, `medium`, `long`, or `very_long`.
204+
- **refresh_rate**: Fine-tune animation smoothness from `5` (battery-saving) to `60` (ultra-smooth) FPS.
213205

214206
## 🎨 Themes
215207

216208
Go Typer includes beautiful themes inspired by popular coding and typing interfaces.
217209

218210
Built-in themes:
219211

220-
- `default`: Clean light theme with green/blue highlights
221-
- `dark`: Sleek dark theme with purple/blue accents
222-
- `monochrome`: Minimalist black and white theme for distraction-free typing
212+
- `default`: Clean light theme with green/blue highlights
213+
- `dark`: Sleek dark theme with purple/blue accents
214+
- `monochrome`: Minimalist black and white theme for distraction-free typing
223215

224216
### 🖌️ Create Your Own Theme
225217

@@ -256,9 +248,9 @@ padding: "#888888" # Padding elements color
256248
257249
Love Go Typer? Contributions are always welcome\!
258250
259-
- Check out our [todos](https://www.google.com/search?q=todos.md) for upcoming features and areas where you can help.
260-
- Feel free to submit pull requests for bug fixes or new features.
261-
- If you have any suggestions or find any issues, please open an issue on GitHub.
251+
- Check out our [todos](https://www.google.com/search?q=todos.md) for upcoming features and areas where you can help.
252+
- Feel free to submit pull requests for bug fixes or new features.
253+
- If you have any suggestions or find any issues, please open an issue on GitHub.
262254
263255
## 📜 License
264256

0 commit comments

Comments
 (0)