Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jacksparrow124 authored Sep 29, 2023
1 parent a6e8237 commit 1ab7f36
Showing 1 changed file with 4 additions and 11 deletions.
15 changes: 4 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,16 @@
<h1> Home Manager GPT</h1>
<h3> Welcome! 😄</h3>
<h2> overview </h2>
<h2> overview </h2>
<ul>
<li href = "https://github.com/jacksparrow124/HM-GPT#requirements-for-part-1">Requirements</li>
<li>how it works 🖥️ </li>
<li>setup 🎈</li>
<h2> Setup</h2>
<p>
You need a paid OpenAI account with an API key to run this code. Attach a Raspberry Pi Pico to a microphone that will record the .mp3 file, then use this code and setup diagram to wire and code the Pico. you will also need a speaker to attach to the pico to return the output. for materials, see Requirements section. 🙂
You need a paid OpenAI account with an API key to run this code. Attach a Raspberry Pi Pico to a microphone that will record the .mp3 file, then use this code and setup diagram to wire and code the Pico. you will also need a speaker to attach to the pico to return the output. for materials, see Requirements section. 🙂 !STILL IN DEVELOPMENT!
</p>
<h2>Requirements for part 1</h2>
<ul>
<li>a paid openai account with api key</li>
<li>a microphone: https://www.adafruit.com/product/1063</li>
<li>speaker: https://www.adafruit.com/product/1314</li>
<li>Raspberry Pi Pico: https://www.adafruit.com/product/5525</li>



<h2>how it works</h2>
<p>
We are using basic ChatGPT 3.5 as a home manager that you can ask to turn on the radio, turn off the lights, and complete other easily automated tasks (fork the repository or create a pull request to add your own features). It uses a microphone to record commands in .mp3 file, then transcribes the .mp3 file to text and gives it to ChatGPT. Speech output is returned through OpenAI's Whisper.
Expand All @@ -28,8 +23,6 @@ The second, optional part of the project is to create a "magic mirror" to house



<h2 align=left>Acessabitlity</h2>
<p> we are currently working on making spanish, chinese, and french versions of the interactive-ness. we would love for others to chip in and help with the effort. to acsess the other language's programs, go to main/main_(the language) and use that code. this will increase ability to customize dramatically. for the time being, we will have the other languages' in main. Once we get the user 1st time start up working, we will move these to a diffrent repo. thanks for understanding! 🙂</p>



0 comments on commit 1ab7f36

Please sign in to comment.