-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #9 from Mikolkar/main
Update Readme and add script
- Loading branch information
Showing
3 changed files
with
835 additions
and
800 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,56 @@ | ||
|
||
# SearchMate 🔎 | ||
|
||
#### *A modular and versatile desktop assistant that searches for apps, performs basic math and makes chatting with GPT easier.* | ||
|
||
The project was created by **UWR** students for | ||
**object-oriented programming** subject. | ||
|
||
## Screenshots | ||
## Video Demonstration | ||
|
||
https://github.com/Mikolkar/searchmate/assets/118861101/38379e21-0752-45bd-861c-4df82000d710 | ||
|
||
**TO-DO** | ||
|
||
## Features | ||
|
||
- Graphical interface with a textbox | ||
- Modular skills | ||
- Apps searching | ||
- Basic math | ||
- ChatGPT integration | ||
|
||
## Installation | ||
|
||
**TO-DO** | ||
#### Installation with poetry: | ||
|
||
```shell | ||
poetry install | ||
``` | ||
#### Installation with pip: | ||
|
||
```shell | ||
pip install -e . | ||
``` | ||
|
||
## Run | ||
|
||
#### With poetry: | ||
|
||
```shell | ||
poetry run python -m searchmate | ||
``` | ||
**or** | ||
```shell | ||
poetry run search | ||
``` | ||
|
||
#### With pip: | ||
|
||
```shell | ||
python -m searchmate | ||
``` | ||
## Usage | ||
|
||
**TO-DO** | ||
- To calculate a mathematical expression in the Searchmate application, you need to first type the word "math", followed by the mathematical expression you want to calculate. For example: "math 2+2". | ||
- If you want to ask a question to the GPT language model, you should type "gpt", followed by your question. It's important to enter your API key into the configuration file in order to use this function. | ||
|
||
- In the case of entering any other phrase, the program will launch the browser and display a page with search results for the entered query. |
Oops, something went wrong.