Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
cdillard committed Dec 27, 2023
1 parent 24dc99a commit 94f5308
Showing 1 changed file with 28 additions and 2 deletions.
30 changes: 28 additions & 2 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,22 @@

---

## Table of Contents
- [Getting Started (iOS/iPadOS)](#getting-started-with-logicsage-ios-ipados)
- [Google Search API Integration](#google-search-api-integration)
- [LogicSageCommandLine Installation Requirements](#logicsagecommandline-installation-requirements)
- [Contact](#contact)
- [Credits](#credits)

### Use LogicSage without Mac

Chat with GPT using tools (google, link) which allow incorporation of Google Search results into GPT responses.

## Getting Started with LogicSage: iOS, iPadOS

with LogicSage: iOS, iPadOS
#### Chat and copy code snippets:

0. Download LogicSage from the AppStore.[link](https://apps.apple.com/us/app/logicsage/id6448485441)
0. Download LogicSage from the [App Store](https://apps.apple.com/us/app/logicsage/id6448485441)
1. LogicSage is a 'Bring Your Own API Key' app. Before you can start chatting, you need to enter an OpenAI API Key (https://platform.openai.com/account/api-keys) in the apps UI.
- it will be stored securely in your devices keychain. It will only be used when sending request to Open AI server (Check the source code in SettingsViewModel to check openAIKey handling.).

Expand All @@ -35,6 +42,8 @@ https://developers.google.com/custom-search/v1/introduction
- Enter Google Search API Key and Google Search API Secret in Settings tab of app.
- Change model to `gpt-4-1106-web-browsing*` (this is added by LogicSage.)

MacOS
---
### Use LogicSage with Mac by connecting to the LogicSageCommandLine app!

(Work in Progress) MacOS / iOS GPT Middleware that allows GPT to build, run, and test Xcode projects.
Expand Down Expand Up @@ -65,6 +74,23 @@ When connected to the LogicSageCommandLine you can use the "Term" window from th
8. Create folder `~/Documents/LogicSageWorkspace`
9. Create folder `~/Documents/LogicSageForMacWorkspace`

## LogicSageCommandLine Installation Requirements
- [Homebrew](https://brew.sh/)
- [Ruby](https://www.ruby-lang.org/en/)
- [Xcode](https://developer.apple.com/xcode/)
- [XcodeGen](https://github.com/yonaskolb/XcodeGen)
- [Xcodeproj](https://github.com/CocoaPods/Xcodeproj)
- [Swift Toolchain Xcode 14.3](https://www.swift.org/download/)

#### Installing Homebrew and Ruby
If you don't have Homebrew and Ruby installed, follow these steps:
1. Install Homebrew by running: `/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
2. Install Ruby by running: `brew install ruby`

#### Installing XcodeGen and Xcodeproj
1. Install XcodeGen: `brew install xcodegen`
2. Install Xcodeproj: `gem install xcodeproj`

---
## Disclaimer

Expand Down

0 comments on commit 94f5308

Please sign in to comment.