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

[Maintenance] Standardise naming of binaries in examples #364

Open
kanerogers opened this issue Sep 26, 2022 · 0 comments
Open

[Maintenance] Standardise naming of binaries in examples #364

kanerogers opened this issue Sep 26, 2022 · 0 comments
Labels
good-first-issue This is a good first issue!

Comments

@kanerogers
Copy link
Collaborator

kanerogers commented Sep 26, 2022

Background

At the moment, each of our examples is called.. lots of different things. Sometimes that's to get around conflicts with targets (eg. the lib is built as hotham_simple_scene so the binary can't be called hotham_simple_scene), other times it's just my laziness.

Solution

Simple naming convention:

  • The lib target is just called by the project name (eg. hotham_simple_scene).
  • The bin target is the project name, with a _desktop suffix (eg. hotham_simple_scene_desktop)

To change the name of a bin target, just modify the Cargo.toml manifest to add / change the following:

[[bin]]
name = "hotham_simple_scene_desktop"
path = "src/main.rs"
@kanerogers kanerogers added the good-first-issue This is a good first issue! label Sep 26, 2022
@kanerogers kanerogers self-assigned this Feb 23, 2023
@kanerogers kanerogers moved this to 🔖 Ready in Hotham 0.3 Feb 23, 2023
@kanerogers kanerogers removed their assignment Feb 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good-first-issue This is a good first issue!
Projects
Status: 🔖 Ready
Development

No branches or pull requests

1 participant