Skip to content

Commit 48f7a03

Browse files
committed
Enhance README with installation instructions
1 parent c481966 commit 48f7a03

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,42 @@
1-
# AiShell
1+
# AiShell 🤖
22

33
A simple Python code that connects to OpenAI's ChatGPT and executes the returned results.
44

5-
## Examples
5+
## Examples 💡
66

7-
### Simple Utility commands
7+
### Simple Utility commands 🛠
88

99
![terminal example](images/aishell_example.png)
1010

11-
### A git helper
11+
### A git helper 💻
1212

1313
![terminal example](images/aishell_example2.png)
1414

15-
### A powerful git assistant: "add all files & amend last commit & push"
15+
### A powerful git assistant 💪🏻👨‍💻💻: "add all files & amend last commit & push"
1616

1717
![terminal example3](images/aishell_example3.png)
1818

19+
## Installation
1920

20-
## Prerequisites
21+
```sh
22+
curl -sL https://raw.githubusercontent.com/code-yeongyu/AiShell/master/install.sh | sh
23+
```
24+
25+
## Prerequisites 📚
2126

2227
- Python 3.9.5
2328
- Poetry
2429
- OpenAI API Key
2530

26-
## Getting Started
31+
## Getting Started 🚀
2732

2833
1. Create account on OpenAI
2934
1. Go to <https://platform.openai.com/account/api-keys>, Copy API key
30-
1. Set the API key as an environment variable OPENAI_API_KEY or inject it directly into the code by editing it.
31-
1. Clone this repository to your local machine using git clone <repository-url>
32-
1. Install the dependencies by running poetry install in your terminal
33-
1. Start AiShell by running poetry run python3 aishell/main.py
35+
1. Set the API key as an environment variable `OPENAI_API_KEY` or inject it directly into the code by editing it.
36+
1. [Install](#installation)
3437

35-
## Contributions
38+
## Contributions 💬
3639

3740
Feel free to contribute to AiShell by adding more functionality or fixing bugs. Some suggestions for contributions include:
3841

39-
- Adding the ability to execute AiShell as a system command aishell <command>
4042
- Publishing AiShell to PyPI so that others can easily download and use it

0 commit comments

Comments
 (0)