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

Add quickstart section at the top of the docs #174

Merged
merged 2 commits into from
Mar 31, 2024
Merged

Add quickstart section at the top of the docs #174

merged 2 commits into from
Mar 31, 2024

Conversation

petdance
Copy link
Contributor

This is a doc patch to include a quickstart section to the top of the docs, so casual users can get what they need without having to go through the details below. This is in response to #173.

Copy link
Collaborator

@nmisch nmisch left a comment

Choose a reason for hiding this comment

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

I like this! I'll give others some time to review. In the absence of
objections, I will merge it on or after 2024-03-30.

If you feel like it, regenerate README.md as follows. Otherwise, I can do it
later.

{ head -n3 README.md; pod2markdown lib/IPC/Run.pm; } >README.md.new && \
  mv -f README.md.new README.md

lib/IPC/Run.pm Outdated

=head2 And beyond

That's the basics of using C<run()> as a replacment for C<system()>. If
Copy link
Collaborator

Choose a reason for hiding this comment

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

s/replacment/replacement/

@petdance
Copy link
Contributor Author

Thanks, I'm glad you like it. I'll let you take care of the README.md and that "replacment" typo if you don't mind.

@nmisch
Copy link
Collaborator

nmisch commented Mar 20, 2024

I'll let you take care of the README.md and that "replacment" typo if you don't mind.

Will do.

@nmisch nmisch merged commit 1f96203 into cpan-authors:master Mar 31, 2024
20 checks passed
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.

2 participants