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

Generate documentation #48

Open
Razaloc opened this issue Nov 19, 2022 · 2 comments
Open

Generate documentation #48

Razaloc opened this issue Nov 19, 2022 · 2 comments

Comments

@Razaloc
Copy link
Contributor

Razaloc commented Nov 19, 2022

The project needs documentation.
There are recommendations and standards for Rust crates documentation:
@Razaloc Razaloc mentioned this issue Nov 21, 2022
Closed
@Razaloc
Copy link
Contributor Author

Razaloc commented Nov 23, 2022

Found out there is a man crate to allow the CLI application to have a man page. Wonder if we want to have one.

@obbardc
Copy link
Contributor

obbardc commented Nov 23, 2022

Found out there is a man crate to allow the CLI application to have a man page. Wonder if we want to have one.

Yes, that'd be great to have when we distribute as a Debian package. Can you check what other binary Rust Debian packages do ?

@Razaloc Razaloc mentioned this issue Nov 25, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs : Add in code documentation collabora/bmap-rs
2 participants
@obbardc @Razaloc