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

Consider renaming the repo and adding a README at the root #341

Closed
ordian opened this issue Sep 23, 2022 · 6 comments
Closed

Consider renaming the repo and adding a README at the root #341

ordian opened this issue Sep 23, 2022 · 6 comments
Labels
A-meta Area: Project-wide C-question Uncertainty is involved

Comments

@ordian
Copy link
Member

ordian commented Sep 23, 2022

Could be renamed to toml or maybe you have better suggestions?

@epage epage added the C-question Uncertainty is involved label Sep 23, 2022
@epage
Copy link
Member

epage commented Sep 23, 2022

Could be renamed to toml or maybe you have better suggestions?

I think that makes sense.

Something I've been considering is if we should rename

  • toml to serde_toml
  • toml_edit to toml

If we had started from scratch, I feel like this is what we would have done but this would be very disruptive.

adding a README at the root

Any thoughts on what we should put in it besides an index of what crates are contained?

@samuelcolvin
Copy link

samuelcolvin commented Sep 23, 2022

Readme would be very useful explaining the purpose of the difference crates.

For example from toml-rs/toml-rs#464 (comment) is toml-rs no longer maintained?

Should I switch rtoml to use this library?

Frankly I'm a bit confused about what's going on.

With import repos like this, a README is a must.

@epage
Copy link
Member

epage commented Sep 23, 2022

We now have a README that at least links to the contained crates with a brief description. If you have feedback on what more is needed, I'd appreciate it.

Hopefully the repo name helps to clarify confusion over pushing people to toml_edit which is not the intent. Should have done the rename before pointing people here.

The overall plan is move toml to be on top of toml_edit, see #340

@epage epage added the A-meta Area: Project-wide label Sep 23, 2022
@samuelcolvin

This comment was marked as off-topic.

@epage

This comment was marked as off-topic.

@epage
Copy link
Member

epage commented Sep 23, 2022

At this point, we've done the rename and have at least an index for a README

@epage epage closed this as completed Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Area: Project-wide C-question Uncertainty is involved
Projects
None yet
Development

No branches or pull requests

3 participants