Skip to content

Commit b3074b5

Browse files
authored
update readme
1 parent 783d3bb commit b3074b5

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# OmegaHH42
2+
3+
A desktop application for monitoring temperature readings from the Omega HH42 thermocouple thermometer.
4+
5+
![License](https://img.shields.io/badge/license-MIT-blue.svg)
6+
7+
## Features
8+
9+
- **Real-time temperature display** - View live readings from your HH42 device
10+
- **Temperature charting** - Visualize temperature trends over time
11+
- **Data logging** - Automatically records readings to a local database
12+
- **CSV export** - Export your data for analysis in Excel or other tools
13+
- **Cross-platform** - Runs on Windows, macOS, and Linux
14+
15+
## Download
16+
17+
Download the latest release for your platform from the [Releases](https://github.com/Pslice/omega-hh42/releases) page:
18+
19+
| Platform | File |
20+
|----------|------|
21+
| Windows | `OmegaHH42 Setup x.x.x.exe` |
22+
| macOS | `OmegaHH42-x.x.x.dmg` |
23+
| Linux | `OmegaHH42-x.x.x.tar.gz` |
24+
25+
## Quick Start
26+
27+
1. Connect your Omega HH42 device via USB
28+
2. Launch OmegaHH42
29+
3. Select your device's COM port from the dropdown or use Simulate mode
30+
4. Temperature readings will appear automatically
31+
32+
## Requirements
33+
34+
- Omega HH42 thermocouple thermometer
35+
- USB cable for device connection
36+
- Windows 10+, macOS 10.13+, or Linux
37+
38+
## macOS Security Note
39+
40+
Since the app is not signed with an Apple Developer certificate, you may need to right-click the app and select **Open**, then click **Open** in the security dialog.
41+
42+
## Building from Source
43+
44+
```bash
45+
# Clone the repository
46+
git clone https://github.com/Pslice/omega-hh42.git
47+
cd omega-hh42
48+
49+
# Install dependencies
50+
npm install
51+
52+
# Run in development mode
53+
npm start
54+
55+
# Build for your platform
56+
npm run dist:win # Windows
57+
npm run dist:mac # macOS
58+
npm run dist:linux # Linux
59+
```
60+
61+
## Getting Help
62+
63+
If you encounter issues or have questions, please [open an issue](https://github.com/Pslice/omega-hh42/issues) on GitHub.
64+
65+
## License
66+
67+
MIT

0 commit comments

Comments
 (0)