Skip to content

Commit 163d917

Browse files
authored
Update README.md
1 parent e53f002 commit 163d917

File tree

1 file changed

+49
-25
lines changed

1 file changed

+49
-25
lines changed

README.md

Lines changed: 49 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,49 @@
1-
# HHK3template
2-
A modern template for HHK3!
3-
4-
Checkout the other branches for more variants.
5-
6-
## How to Setup
7-
1. Clone to project
8-
2. Enter the devcontainer
9-
3. `make compile_commands.json` or use the vscode task
10-
4. Restart clangd (eg. via CRTL+SHIFT+P in vscode)
11-
12-
## How to build
13-
```sh
14-
make -j
15-
```
16-
Or execute the default vscode build task with CRTL+SHIFT+B
17-
18-
## How to run
19-
Copy `dist/CPapp.hh3` to the root of the calculator when connected in usb storage mode and then select and run from the launcher.
20-
21-
## How to change the file name (recommended)
22-
Open the Makefile and adjust this line to what you want:
23-
```Makefile
24-
APP_ELF := $(OUTDIR)/<your_file_name>.elf
25-
```
1+
<h4 align="center">A Ping Pong game for the Casio FX-CP400 with HollyHock-3</h4>
2+
3+
<p align="center">
4+
<a href="#how-to-use">How To Use</a> •
5+
<a href="#download">Download</a> •
6+
<a href="#credits">Credits</a> •
7+
<a href="#community">Community</a>
8+
</p>
9+
10+
<p align="center">
11+
<img src="https://raw.githubusercontent.com/PyCSharp/CPPong-For-HHK3/refs/heads/main/image.jpg" alt="CPPong Screenshot" width="400"/>
12+
</p>
13+
14+
---
15+
16+
## How To Use
17+
18+
1. Copy the `.hh3` game file into the **root directory** of your calculator
19+
(do not place it inside a subfolder).
20+
21+
2. Launch the calculator and open the game through Hollyhock Launcher.
22+
23+
3. Controls:
24+
- Player 1: `` / ``
25+
- Player 2: `1` / `3`
26+
- `5` = restart game
27+
- `EXE` or `Clear` = quit
28+
29+
---
30+
31+
## Download
32+
33+
👉 [Download the latest release here](https://github.com/PyCSharp/CPPong-For-HHK3/releases)
34+
35+
The release contains the `.hh3` file you just need to copy onto your calculator.
36+
37+
---
38+
39+
## Credits
40+
41+
- [Original Code for HHK2](https://github.com/SnailMath/CPpong) by **SnailMath**
42+
- [HHK3 Template](https://github.com/QBos07/HHK3template) by **QBos07**
43+
44+
---
45+
46+
## Community
47+
48+
Join the discussion, share feedback and get help on the Snail Math Discord Server:
49+
👉 [https://discord.com/invite/knpcNJTzpd](https://discord.com/invite/knpcNJTzpd)

0 commit comments

Comments
 (0)