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

README: Add 'Getting started' directions #43

Merged
merged 4 commits into from
Jul 28, 2021
Merged

README: Add 'Getting started' directions #43

merged 4 commits into from
Jul 28, 2021

Conversation

cassidyjames
Copy link
Contributor

Based on #29, but a bit expanded and hopefully addressing concerns on that PR. Omits docs instructions for now as I'm not familiar with how that works.

@cassidyjames
README: Add 'Getting started' directions
0d23846 
Based on #29, but a bit expanded and hopefully addressing concerns on that PR. Omits docs instructions for now as I'm not familiar with how that works.
@cassidyjames cassidyjames marked this pull request as draft June 21, 2021 17:12
@cassidyjames cassidyjames marked this pull request as ready for review June 21, 2021 17:36
@cassidyjames
Copy link
Contributor Author

cassidyjames commented Jun 21, 2021 •
edited
Loading

I would like to add a section like this at the end, but am unable to actually build the docs locally for some reason, so I'm omitting for now:

Docs

libportal can optionally generate docs with the gtk_doc option which defaults to true. View the resulting documentation in the doc/html/ subdirectory of your build directory, e.g.:

gio open _build/doc/html/index.html

GeorgesStavracas
GeorgesStavracas requested changes Jul 28, 2021
View reviewed changes
Copy link
Member

@GeorgesStavracas GeorgesStavracas left a comment

Choose a reason for hiding this comment

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

Mostly looks good, clearly an improvement over the single sentence we currently have, but could you please limit the line width to 80 characters?

GeorgesStavracas
GeorgesStavracas requested changes Jul 28, 2021
View reviewed changes
Copy link
Member

@GeorgesStavracas GeorgesStavracas left a comment

Choose a reason for hiding this comment

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

Okay, sorry I didn't catch this in the previous round. I think it's good to land after these adjustments.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
GeorgesStavracas
GeorgesStavracas approved these changes Jul 28, 2021
View reviewed changes
Copy link
Member

@GeorgesStavracas GeorgesStavracas left a comment

Choose a reason for hiding this comment

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

Thank you so much!

@GeorgesStavracas GeorgesStavracas merged commit c3407aa into flatpak:master Jul 28, 2021
@cassidyjames cassidyjames deleted the patch-1 branch July 28, 2021 16:28
@cassidyjames cassidyjames mentioned this pull request Jul 28, 2021
Merged
GeorgesStavracas pushed a commit that referenced this pull request Jul 28, 2021
@cassidyjames @GeorgesStavracas
README: use portal-test option in examples
fa471b0 
Missed in #43
GeorgesStavracas pushed a commit to GeorgesStavracas/libportal that referenced this pull request Nov 21, 2021
@cassidyjames @GeorgesStavracas
README: use portal-test option in examples
01a5e54 
Missed in flatpak#43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GeorgesStavracas GeorgesStavracas GeorgesStavracas approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cassidyjames @GeorgesStavracas