-
-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readme update #936
Readme update #936
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
While we are updating this I think all uses of "REST API" should be replaced with "API". When I wrote this I didn't really know what I was talking about. REST API is incorrect, our API is not RESTful and does not intend to be.
[![Build Status][workflow-badge]][workflow-link] [![Coverage][coverage-badge]][coverage-link] [![GPL License][license-badge]](COPYING) | ||
|
||
![AmpliPi](docs/imgs/amplipi.jpg) | ||
![AmpliPi](docs/imgs/AmpliProOverview2.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This picture is showing the old interface on the phone and pc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have an updated photo? I might be able to overlay a screenshot on the laptop in draw.io but the phone will look like a weird rectangle if I try and do the same.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/docs/manual/imgs
has the updated version I whipped up for our manual
In my PR (#923) where I create more manuals, that folder structure is rebuilt to be /docs/manuals/imgs
, whoever is able to merge last will need to keep an eye out to change this to the proper pathing
@gorski123 @rtertiaer I updated the image and reordered the AmpliPi vs AmpliPro Paragraph. Unless you feel we need to reword anything I'm ready for approval |
README.md
Outdated
@@ -1,4 +1,7 @@ | |||
# AmpliPro Home Audio System | |||
# AmpliPi Home Audio Software |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think System is a better description. Software is overly generic and useless its like putting AI in the name of something.
One potential option if system is off the table is Platform but I still prefer System here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I changed it to system. I think you're right.
Please use squash and edit the message when merging this. This all should end up as a single commit. |
a quick guide to squashing, since I feel you might not have come across that yet and it was annoying when I tried to google it way back when because everyone seems to have their own style for some reason: run
in your terminal and replace all but the first instance of "pick" with "s" or "squash", then save the file and continue From there, you'll likely have to run
to send your squash upstream, forcefully rewriting your history from n commits into a single commit |
Changes made, awaiting approval @gorski123 |
- Added a description of the difference between AmpliPi and AmpliPro - Replaced "AmpliPi" with "AmpliPro when in reference to the device - Added a link to micro-nova.com to make it easy to buy an AmpliPro - Changed two pictures: The front+back photo of the device, and the API diagram
434400a
to
2213f16
Compare
What does this change intend to accomplish?
Update to the readme.md:
Checklist