Skip to content

Commit d006c78

Browse files
authored
Update README.md
1 parent b2c48e4 commit d006c78

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
OpenAI-VBA-Framework is an independent toolkit for developers to build VBA applications with OpenAI's language models like GPT-4, ChatGPT, and DALL-E. It offers a suite of classes for easy integration with OpenAI's API. Please note, this project is not officially associated with or endorsed by OpenAI.
66

7+
## Prerequisites
8+
- You will need to sign up for an OpenAI account and create an API_KEY. You can do this at the following location: [OpenAI API Keys](https://platform.openai.com/account/api-keys)
9+
710
## Main Classes
811
1. `clsOpenAI` - Main class to interact with OpenAI
912
2. `clsOpenAILogger` - Logging class for debugging and tracking
@@ -17,21 +20,6 @@ The module `mdOpenAI_tests` is provided for testing the functionality of the fra
1720

1821
`OpenAIFrameworkDemo.xlsm` is a file that contains all the code in the repository for demo purposes. Other files are also included in the repository for versioning.
1922

20-
## Prerequisites
21-
- You will need to sign up for an OpenAI account and create an API_KEY. You can do this at the following location: [OpenAI API Keys](https://platform.openai.com/account/api-keys)
22-
23-
## Installation
24-
1. Clone this repository using the following command in your command line:
25-
26-
```bash
27-
git clone https://github.com/zq99/OpenAI-VBA-Framework.git
28-
```
29-
30-
2. Open Excel and press ALT + F11 to open the VBA editor.
31-
3. From the toolbar select File -> Import File....
32-
4. Navigate to the location of the cloned repository and select all the .cls and .bas files then click Open.
33-
5. Save the Excel file as a macro-enabled workbook .xlsm.
34-
3523
## Usage
3624

3725
Here are some examples of using the framework:
@@ -146,6 +134,18 @@ Dim apiKey As String
146134
apiKey = oOpenAI.GetReadAPIKeyFromFolder("<FolderPath>")
147135
```
148136

137+
## Installation (via GIT)
138+
1. Clone this repository using the following command in your command line:
139+
140+
```bash
141+
git clone https://github.com/zq99/OpenAI-VBA-Framework.git
142+
```
143+
144+
2. Open Excel and press ALT + F11 to open the VBA editor.
145+
3. From the toolbar select File -> Import File....
146+
4. Navigate to the location of the cloned repository and select all the .cls and .bas files then click Open.
147+
5. Save the Excel file as a macro-enabled workbook .xlsm.
148+
149149
## Troubleshooting
150150

151151
You can check the status of the OpenAI API [here](https://status.openai.com/).

0 commit comments

Comments
 (0)