Skip to content

Conversation

@iinuwa
Copy link
Member

@iinuwa iinuwa commented Aug 13, 2025

  • Update project name to credentialsd.
  • Add BUILDING.md, reference build instructions in README.md and webext/README.md
  • Move goals to separate file.

Closes #85.

@iinuwa iinuwa force-pushed the readme-update branch 2 times, most recently from f9aeac2 to 7109d86 Compare August 13, 2025 19:05
Copy link
Collaborator

@msirringhaus msirringhaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments and nits.

BUILDING.md Outdated

# For Installing/Testing

If you are interested in installing the program, you can use `meson install` to install the details.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mention here that it is not necessary to install it to test it (see "Running the server"-instructions). Many contributors/testers/users will probably like to first run it in a 'throw away' fashion.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I wanted to keep it simple for testers because there's a bunch of editing and manual file pl. But I can add a statement pointing to the instructions below.

Suggested change
If you are interested in installing the program, you can use `meson install` to install the details.
If you are interested in installing the program, you can use `meson install` to install the details. (If you would like to test without installing, you can
follow the [build instructions for development](#for-development) below.)

GOALS.md Outdated
@@ -0,0 +1,55 @@
# Goals

The goal of this repository is to define a spec for clients (apps, browsers,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we provide more than 'just' a spec?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, reworded this one a bit.

GOALS.md Outdated

The goal of this repository is to define a spec for clients (apps, browsers,
etc.) to retrieve user credentials in a uniform way across Linux desktop
environments.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe mention the other OS-level services of Windows, Mac and Android for comparison here, for people familiar with these services?

We could also mention for more clarity that currently on Linux, every app (e.g. browsers) that wants to support FIDO, etc. has to implement these things on their own, instead of "asking the OS for it", as is done on other OS's, which this project tries to change.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point. I added a "Motivation" section before describing the goals.

Copy link
Collaborator

@msirringhaus msirringhaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@iinuwa iinuwa merged commit bb238e7 into main Aug 14, 2025
1 check passed
@iinuwa iinuwa deleted the readme-update branch August 14, 2025 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add BUILDING.md

4 participants