Skip to content

Commit af13b71

Browse files
committed
added executables.
1 parent 827c5e7 commit af13b71

File tree

3 files changed

+103
-5
lines changed

3 files changed

+103
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,21 @@
22

33
A real-time chart application that displays and monitors the price ratio between NVIDIA (NVDA) and TSMC (TSM) stocks using Interactive Brokers API.
44

5+
## Quick Start (Windows Users)
6+
7+
### Download and Run
8+
1. Go to the [Releases](../../releases/latest) page
9+
2. Download `NVDA_TSM_Ratio_Chart.exe` from the latest release
10+
3. Download `README.txt` for detailed instructions
11+
4. Start TWS/Gateway and log in
12+
5. Double-click the downloaded executable
13+
14+
That's it! The chart will automatically update every 10 seconds.
15+
16+
[![Download Latest Release](https://img.shields.io/github/v/release/yourusername/nvda-tsm-ratio-chart?include_prereleases&label=Download&style=for-the-badge)](../../releases/latest)
17+
18+
---
19+
520
## Features
621

722
- Real-time price ratio monitoring
@@ -12,13 +27,22 @@ A real-time chart application that displays and monitors the price ratio between
1227
- Support for both real-time and delayed market data
1328
- Current local time display
1429

30+
## Screenshots
31+
32+
![Chart Screenshot](screenshots/chart_example.png)
33+
1534
## Requirements
1635

17-
- Python 3.8 or higher
1836
- Interactive Brokers TWS (Trader Workstation) or IB Gateway
1937
- Market data subscriptions for NVDA and TSM
2038

21-
## Installation
39+
For developers:
40+
- Python 3.8 or higher
41+
- Dependencies listed in requirements.txt
42+
43+
## For Developers
44+
45+
### Installation
2246

2347
1. Clone the repository:
2448
```bash
@@ -31,8 +55,6 @@ cd nvda-tsm-ratio-chart
3155
pip install -r requirements.txt
3256
```
3357

34-
## Usage
35-
3658
### Running from Source
3759

3860
1. Start TWS/Gateway and log in
@@ -71,7 +93,10 @@ python build_simple.py
7193
├── build_simple.py # Build script for Windows executable
7294
├── requirements.txt # Python dependencies
7395
├── README.md # Project documentation
74-
└── LICENSE # MIT License
96+
├── LICENSE # MIT License
97+
└── dist/ # Distribution directory
98+
├── NVDA_TSM_Ratio_Chart.exe # Windows executable
99+
└── README.txt # User instructions
75100
```
76101

77102
## Development

RELEASE_INSTRUCTIONS.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Creating a GitHub Release
2+
3+
Follow these steps to create a new release with the Windows executable:
4+
5+
1. Build the executable:
6+
```bash
7+
python build_simple.py
8+
```
9+
10+
2. Create a new release on GitHub:
11+
- Go to your repository on GitHub
12+
- Click on "Releases"
13+
- Click "Create a new release"
14+
- Click "Choose a tag" and create a new tag (e.g., v1.0.0)
15+
- Set the release title (e.g., "Version 1.0.0")
16+
- Add release notes describing the changes
17+
- Drag and drop or select these files:
18+
- dist/NVDA_TSM_Ratio_Chart.exe
19+
- dist/README.txt
20+
21+
3. Release notes template:
22+
```
23+
## NVDA/TSM Ratio Chart v1.0.0
24+
25+
### Installation
26+
1. Download NVDA_TSM_Ratio_Chart.exe
27+
2. Download README.txt for instructions
28+
3. Make sure Interactive Brokers TWS/Gateway is running
29+
4. Double-click the executable to run
30+
31+
### Requirements
32+
- Interactive Brokers TWS or Gateway
33+
- Market data subscriptions for NVDA and TSM
34+
35+
### Changes in this version
36+
- Initial release
37+
- Real-time ratio monitoring
38+
- 100-minute historical data
39+
- Auto-updates every 10 seconds
40+
```
41+
42+
4. After creating the release:
43+
- The download badge in README.md will automatically update
44+
- Users can download directly from the Releases page
45+
- The latest release will be linked from the repository homepage
46+
47+
Remember to:
48+
- Tag releases with semantic versioning (vX.Y.Z)
49+
- Include both the executable and README.txt
50+
- Test the downloaded files before marking as the latest release

screenshots/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Screenshots Directory
2+
3+
This directory contains screenshots of the application for documentation purposes.
4+
5+
## Expected Files
6+
7+
- `chart_example.png`: Main chart interface showing NVDA/TSM ratio with moving average
8+
- Resolution: 1280x720 or higher recommended
9+
- Should show:
10+
- Price ratio line
11+
- Moving average
12+
- Statistics panel
13+
- Current time display
14+
- Clear axis labels
15+
16+
## Adding Screenshots
17+
18+
When adding new screenshots:
19+
1. Use dark theme (default)
20+
2. Ensure the chart has sufficient data points
21+
3. Capture during market hours for realistic data
22+
4. Include both the ratio chart and statistics panel
23+
5. Name files descriptively (e.g., chart_example.png, settings_window.png)

0 commit comments

Comments
 (0)