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 instructions on the readme file #112

Merged
merged 6 commits into from
May 20, 2022
Merged

Conversation

rudymatela
Copy link

@rudymatela rudymatela commented May 18, 2022

Closes #111

This PR adds instructions on how to use Hoff on the README file along with a few other minor README improvements:

  • add instructions on the readme file
  • remove broken links
  • remove the old badge that points to the Travis build of Ruud's repo. Currently is not possible to add a badge for Semaphore due to the project being marked as private there, see issue Public CI for Hoff? #113.

Mr. PR reviewer: you may be interested in looking at the updated readme.md before and/or after looking at the diff.

@rudymatela rudymatela marked this pull request as draft May 18, 2022 15:02
@rudymatela rudymatela self-assigned this May 18, 2022
* merge and tag only tags
* merge and deploy tags then deploys
... as this version of the repo actually uses Semaphone and has a different
build status.
@rudymatela rudymatela requested a review from fatho May 19, 2022 15:02
@rudymatela
Copy link
Author

@fatho This is ready for review. Can you please take a look?

Don't forget to look at the rendered readme.md file before approving.

Copy link
Member

@fatho fatho 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 it, very clear and succinct 👍

Just some technicalities below:

readme.md Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@rudymatela rudymatela marked this pull request as ready for review May 20, 2022 07:35
@rudymatela
Copy link
Author

I like it, very clear and succinct +1

Thanks! 😄

@rudymatela
Copy link
Author

@OpsBotPrime merge

@OpsBotPrime
Copy link

Your merge request has been denied, because merging on Fridays is not recommended. To override this behaviour use the command merge on Friday.

@rudymatela
Copy link
Author

@OpsBotPrime merge on friday

@OpsBotPrime
Copy link

Pull request approved for merge by @rudymatela, rebasing now.

Approved-by: rudymatela
Auto-deploy: false
@OpsBotPrime
Copy link

Rebased as 9687649, waiting for CI …

@OpsBotPrime OpsBotPrime merged commit 9687649 into master May 20, 2022
@OpsBotPrime OpsBotPrime deleted the doc/readme-instructions branch May 20, 2022 08:32
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.

Update the README documentation
3 participants