Skip to content
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: Header redesign #2032

Merged
merged 59 commits into from
Oct 23, 2024
Merged

README: Header redesign #2032

merged 59 commits into from
Oct 23, 2024

Conversation

liamcharger
Copy link
Contributor

@liamcharger liamcharger commented Feb 28, 2024

This PR enhances the visual appeal of the main README.md header with a restyled header design. Open to feedback and suggestions for further improvements!

Additionally, in the README body, I've included a reference to InfiniTimeExplorer since its existence is not widely known.

Please refer to my InfiniTime fork for a preview of the changes.

@liamcharger liamcharger changed the title Restyle README.md README: Header redesign Mar 1, 2024
@rambonette
Copy link

Looks very nice imo 👏

@liamcharger
Copy link
Contributor Author

this looks great! I didn't know you could combine html tags with markdown

I especially like the collage. I'm curious, how did you create it?

Glad you like it! I did it in Adobe Photoshop by taking several screenshots from InfiniSim ;) and then merging each screen with a representation of the physical watch that was used in InfiniLink. Then I positioned everything, added the screen that's stacked on the others, and lastly, I added a circle with a Gaussian blur behind everything for the shadow effect.

@tituscmd
Copy link
Contributor

tituscmd commented Oct 1, 2024

This is beautiful. Great work!

Copy link
Member

@mark9064 mark9064 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks really pretty :)

@FintasticMan
Copy link
Member

I like the way it looks, but I do find it a bit strange that the yellow in the picture is darker than it "should" be.

@liamcharger
Copy link
Contributor Author

I do find it a bit strange that the yellow in the picture is darker than it "should" be.

Not sure if it really matters, but do you mean the yellow in the InfiniTime logo?

@FintasticMan
Copy link
Member

Yeah, the yellow in the InfiniTime logo is darker than other places we use it. It looks like the colours are inverted actually, so I can see how it happened. I feel like maybe you could use the picture we use for the recovery firmware, that's on a black background.

@FintasticMan
Copy link
Member

@liamcharger I think you accidentally pushed an unrelated change to this branch. We recommend using separate branches for each PR, and not using main, to prevent this happening by accident.

@liamcharger
Copy link
Contributor Author

Oops, that was an accident...thought I was on a different branch.

@liamcharger
Copy link
Contributor Author

I feel like maybe you could use the picture we use for the recovery firmware, that's on a black background.

@FintasticMan do you know where I can get an image resource of the recovery firmware picture?

@liamcharger liamcharger requested a review from mark9064 October 22, 2024 16:17
Copy link
Member

@mark9064 mark9064 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Compare the colour of the centre picture to what's currently on the README
image

I'm assuming Fin means this?

@liamcharger
Copy link
Contributor Author

Ok, I'll do that.

@liamcharger
Copy link
Contributor Author

@FintasticMan @mark9064 @JF002 all done!

Copy link
Member

@FintasticMan FintasticMan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! If you update it to the latest main I'll merge it.

@liamcharger
Copy link
Contributor Author

Great! The branch is already up to date, though.

@FintasticMan
Copy link
Member

Ah, sorry, I had rebase merge selected rather than squash merge.

@FintasticMan FintasticMan merged commit 879bdcc into InfiniTimeOrg:main Oct 23, 2024
jmlich pushed a commit to jmlich/InfiniTime that referenced this pull request Dec 22, 2024
* Reformat README.md

* Update README.md

* Add files via upload

* Add files via upload

* Add new README.md header image

* Remove unnecessary <br> tag

* Scale watchface logo down; add downloads badge

* Remove unnecessary <br> tag

* Add <br> tag to maintain spacing consistency

* Remove incorrect link

* Add watchface logo with dark logo

* Replace logo image with dark version

* Add files via upload

* Add header image

* Fix row spacing in header image

* Remove unnecessary <br> tag

* Add corner radius to header image

* Add files via upload

* Update image background

* Add reference to InfiniTimeExplorer

* Remove unnecessary image

* Remove unnecessary image

* Remove unnecessary images

* Rename watchface_collage_no_shadow.png to watchface_collage.png

* Update header image URL

* Remove unnecessary <br> tag

* SPI transaction hooks

* Remove task to notify

* Refactor display WriteToRam

* Use functional abstraction for hooks

* Refactor lambdas

* Avoid storing lambda

* Rename to pre-transaction hook

* Use FreeRTOS delay instead of spinning the CPU

* Apply display driver datasheet delays

* Move includes back

* Include task header (Fixes sim)

* Make chime vibrate twice

* Remove commit from main

* README: improve wording

* Add bootloader to DeviceInformationService.cpp

* Add bootloader to DeviceInformationService.h

* Revert "Add bootloader to DeviceInformationService.h"

This reverts commit f3f0fd5.

* Revert "Add bootloader to DeviceInformationService.cpp"

This reverts commit 35570ed.

* Delete doc/logo/watchface_collage.png

* Add files via upload

* Delete doc/logo/watchface_collage.png

* Add files via upload

* Replace collage with correct image

---------

Co-authored-by: mark9064 <30447455+mark9064@users.noreply.github.com>
BurninTurtles pushed a commit to BurninTurtles/InfiniTimeBT that referenced this pull request Mar 3, 2025
* Reformat README.md

* Update README.md

* Add files via upload

* Add files via upload

* Add new README.md header image

* Remove unnecessary <br> tag

* Scale watchface logo down; add downloads badge

* Remove unnecessary <br> tag

* Add <br> tag to maintain spacing consistency

* Remove incorrect link

* Add watchface logo with dark logo

* Replace logo image with dark version

* Add files via upload

* Add header image

* Fix row spacing in header image

* Remove unnecessary <br> tag

* Add corner radius to header image

* Add files via upload

* Update image background

* Add reference to InfiniTimeExplorer

* Remove unnecessary image

* Remove unnecessary image

* Remove unnecessary images

* Rename watchface_collage_no_shadow.png to watchface_collage.png

* Update header image URL

* Remove unnecessary <br> tag

* SPI transaction hooks

* Remove task to notify

* Refactor display WriteToRam

* Use functional abstraction for hooks

* Refactor lambdas

* Avoid storing lambda

* Rename to pre-transaction hook

* Use FreeRTOS delay instead of spinning the CPU

* Apply display driver datasheet delays

* Move includes back

* Include task header (Fixes sim)

* Make chime vibrate twice

* Remove commit from main

* README: improve wording

* Add bootloader to DeviceInformationService.cpp

* Add bootloader to DeviceInformationService.h

* Revert "Add bootloader to DeviceInformationService.h"

This reverts commit f3f0fd5.

* Revert "Add bootloader to DeviceInformationService.cpp"

This reverts commit 35570ed.

* Delete doc/logo/watchface_collage.png

* Add files via upload

* Delete doc/logo/watchface_collage.png

* Add files via upload

* Replace collage with correct image

---------

Co-authored-by: mark9064 <30447455+mark9064@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants