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

Housekeeping for 0.7 #12

Merged
merged 26 commits into from
May 24, 2021
Merged

Housekeeping for 0.7 #12

merged 26 commits into from
May 24, 2021

Conversation

jamwaffles
Copy link
Member

@jamwaffles jamwaffles commented May 22, 2021

Progress towards #8 and #5, closes #7, closes #6.

@jamwaffles
Copy link
Member Author

Rectangle intersection moved to embedded-graphics/debug-tools#9.

@jamwaffles jamwaffles changed the title Update examples for 0.7 Housekeeping for 0.7 May 22, 2021
@jamwaffles jamwaffles requested a review from rfuest May 22, 2021 18:00
@jamwaffles
Copy link
Member Author

A bit of a kitchen sink PR, but I think I've covered most points in the other issues in this repo

@jamwaffles jamwaffles marked this pull request as ready for review May 24, 2021 14:39
Copy link
Member

@rfuest rfuest left a comment

Choose a reason for hiding this comment

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

First round of reviews

eg-next/examples/primitives-fill.rs Outdated Show resolved Hide resolved
eg-next/examples/primitives-fill.rs Show resolved Hide resolved
eg-next/examples/primitives-fill.rs Outdated Show resolved Hide resolved
eg-next/examples/primitives-fill.rs Show resolved Hide resolved
eg-next/examples/primitives-triangles.rs Outdated Show resolved Hide resolved
eg-next/examples/primitives-triangles.rs Outdated Show resolved Hide resolved
eg-next/examples/primitives-triangles.rs Outdated Show resolved Hide resolved
eg-next/examples/text-alignment.rs Outdated Show resolved Hide resolved
eg-next/examples/text-alignment.rs Outdated Show resolved Hide resolved
eg-next/examples/text-styles.rs Outdated Show resolved Hide resolved
@rfuest
Copy link
Member

rfuest commented May 24, 2021

Closes #8, closes #7, closes #6, closes #5

#8 still need some work after this PR is done.

And this PR is a good start towards #5, but could also use some work. Should we also add licensing information to the readme?

@rfuest
Copy link
Member

rfuest commented May 24, 2021

  • Should we move simulator-input-handling to the examples directory in the simulator repo?
  • Should we rename line-thickness to primitives-line-thickness or also move it debug-tools?
  • Can we set the initial progress value in demo-progress to something != 0? This would make the screenshot more interesting.
  • text-custom-font will need to be fixed after the next beta release.

This is really a debug tool and is already sorted by the "line" example
in embedded-graphics/debug-tools.
@jamwaffles
Copy link
Member Author

To address your points in order:

  1. Agreed, that example really doesn't make sense here does it. Moved in Move input handling example from embedded-graphics/examples simulator#26
  2. I've deleted it, as we already have the line debug tool which does the same thing AFAICS.
  3. Set to >0 now, looks better indeed.
  4. 👍

As for the licenses, I can use the same structure as the e-g repo. Let me do that quick...

jamwaffles added a commit to embedded-graphics/simulator that referenced this pull request May 24, 2021
@jamwaffles
Copy link
Member Author

Licenses are added, MIT or Apache 2.0 the same as e-g. I also added them to the Cargo.toml of each folder which isn't really necessary, but can't hurt.

@jamwaffles jamwaffles requested a review from rfuest May 24, 2021 15:51
@rfuest
Copy link
Member

rfuest commented May 24, 2021

Some final comments:

  • I would prefer to keep the analog prefix for the clock demo, because I'm considering to add a eg-seven-segment based digital clock example to this repo: https://github.com/embedded-graphics/eg-seven-segment/blob/master/examples/digital-clock.rs
  • IMO primitives-ellipse and primitives-rounded-rectangles are debug tools. Should we remove them? Both primitives are used in other examples.
  • The comment in text-fonts says: "Demonstrate the available builtin fonts." We should either change the comment to state that this is a subset of available fonts and a full list is included in the docs or add all fonts to the example. I guess the first solution would be easier to implement and maintain in the future.
  • text-extended-characters: The comment needs to be updated, because all builtin fonts support the characters in this example

jamwaffles added a commit to embedded-graphics/debug-tools that referenced this pull request May 24, 2021
@jamwaffles
Copy link
Member Author

Changes addressed :)

Copy link
Member

@rfuest rfuest 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, only one small issue left.

LICENSE-MIT Outdated
Comment on lines 1 to 2
Copyright (c) 2020 James Waples

Copy link
Member

Choose a reason for hiding this comment

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

Other creates in the Rust ecosystem (including the main rust repo) have removed this line from the MIT license. I think the TLDR was that each author retains the copyright to their contribution and that a global copyright is invalid anyway.

Suggested change
Copyright (c) 2020 James Waples

Copy link
Member Author

Choose a reason for hiding this comment

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

Makes sense. I've removed it from the license file.

jamwaffles added a commit to embedded-graphics/debug-tools that referenced this pull request May 24, 2021
@rfuest
Copy link
Member

rfuest commented May 24, 2021

Should we "fork" the eg-0.7 examples directory in this PR? Because the Cargo.toml in eg-next was supposed to always use git dependencies.

@jamwaffles
Copy link
Member Author

Ah, no, I think we should do that when 0.7 is released. Technically there's no proper release yet, so keeping eg-next as is for the short term makes sense to me. I've reverted the dependency changes back to the git/patches for this PR.

@rfuest
Copy link
Member

rfuest commented May 24, 2021

OK. But I have to admit that finally seeing the Cargo.toml without any git dependencies looked really good.

@jamwaffles
Copy link
Member Author

Thanks for the reviews! These examples look really good now.

But I have to admit that finally seeing the Cargo.toml without any git dependencies looked really good.

It did look spectacular! The quicker we can get the migration guide done the quicker we can release non-beta and go back to non-Git Cargo.toml utopia ;)

@jamwaffles jamwaffles merged commit 3e2655a into main May 24, 2021
@jamwaffles jamwaffles deleted the update-examples branch May 24, 2021 17:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update examples with thick triangle/polyline Add screenshot generation commands to justfile
2 participants