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.

Sign up for GitHub

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

Jump to bottom

Create documentation for Cross.toml #664

Closed
Emilgardis opened this issue Mar 17, 2022 Discussed in #532 · 1 comment
Closed

Create documentation for Cross.toml #664

Emilgardis opened this issue Mar 17, 2022 Discussed in #532 · 1 comment
Labels
docs-problem

Comments

@Emilgardis
Copy link
Member

Discussed in #532

We should add some kind of specification, this should be helped with #657
@mntns mntns mentioned this issue Mar 22, 2022
Merged
bors bot added a commit that referenced this issue Mar 22, 2022
@bors @mntns
Merge #670
b40f3fc 
670: Implement `Cross.toml` deserialization using `serde` r=Emilgardis a=mntns

This PR implements the deserialization of the `Cross.toml` config using `serde`. It can therefore be seen as some preliminary work on the issues #657, #664, and is related to #532 on #624.

I added some basic documentation as module-level documentation, although I'm not sure whether this is the best place for that. Ideally it should be documentated in the `README.md` at some point. Furthermore, `CrossToml` lives in its own module, but a more suitable place might be the `config` module.

Co-authored-by: Niklas Kunz <git@monoton.space>
@Alexhuszagh
Copy link
Contributor

Cross.toml is now extensively documented on the wiki, which includes a link to a sample configuration file where every variable is explained in depth.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs-problem
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Emilgardis @Alexhuszagh