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

Rework README #20

Open
solardiz opened this issue May 28, 2022 · 2 comments
Open

Rework README #20

solardiz opened this issue May 28, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@solardiz
Copy link
Member

Our current README dates back to when this was only a PAM module. Now we also have a library and tools. We should replace the contents of README to describe the whole project as it currently is, probably moving most of what's currently in README to a new file - e.g., call it OPTIONS?

@solardiz solardiz added the documentation Improvements or additions to documentation label May 28, 2022
@ldv-alt
Copy link
Collaborator

ldv-alt commented May 28, 2022

Yes, this makes sense, there should be a file describing the whole project, but I'm not volunteering to do this job. :)
Given that options are also described in passwdqc.conf(5) manual page, maybe the file describing pam_passwdqc should rather focus on other aspects, e.g. pam stack integration.

@solardiz
Copy link
Member Author

I was thinking that we wouldn't have a separate text "file describing pam_passwdqc" - rather, the options list moved from README to e.g. OPTIONS would describe the configuration options most of which are not specific to the PAM module alone, but are also supported across other components. Yes, it would be duplicate with passwdqc.conf(5) - just different format.

Currently, PAM stack integration would fit (albeit not perfectly) into PAM-using systems' sections in PLATFORMS.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants