dearwolf/sourcegit
1
0
Fork 0
mirror of https://github.com/sourcegit-scm/sourcegit synced 2025-05-31 00:54:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

enhance: API Key is now optional

Browse source 
- Update README.md by adding tips for using OpenAI in this project
This commit is contained in:
leo 2024-09-13 20:46:00 +08:00
parent 6fc972cc24
commit ab54ecee42
No known key found for this signature in database
3 changed files with 20 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -87,6 +87,19 @@ For **Linux** users:
* Make sure [git-credential-manager](https://github.com/git-ecosystem/git-credential-manager/releases) is installed on your linux.
* Maybe you need to set environment variable `AVALONIA_SCREEN_SCALE_FACTORS`. See https://github.com/AvaloniaUI/Avalonia/wiki/Configuring-X11-per-monitor-DPI.
## OpenAI
This software supports using OpenAI or other AI service that has an OpenAI comaptible HTTP API to generate commit message. You need configurate the service in `Preference` window.
For `OpenAI`:
* `Server` must be `https://api.openai.com/v1/chat/completions`
For other AI service:
* The `Server` should fill in a URL equivalent to OpenAI's `https://api.openai.com/v1/chat/completions`
* The `API Key` is optional that depends on the service
## External Tools
This app supports open repository in external tools listed in the table below.