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

Fix/improve install from source docs #231

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

axelsimon
Copy link

Quick doc + README fixes.

File was messed up: fix and improve.
Fix broken link to /doc/installation/source.md
Copy link
Owner

@joeyates joeyates left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I've added a couple of notes for quick fixes


Check that it runs
You ca now run the following to see the built-in help:
Copy link
Owner

Choose a reason for hiding this comment

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

There's a typo here

```
imap-backup 14.4.4
```
congratulations, you have succesfully built imap-backup.
Copy link
Owner

Choose a reason for hiding this comment

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

There should be a blank line after code blocks.

@@ -143,7 +143,9 @@ If that doesn't work, see the [detailed installation instructions](/docs/install

<details>
<summary>From Source Code</summary>

Copy link
Owner

Choose a reason for hiding this comment

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

From what I can see, this doesn't change the rendered document. Is the newline needed?

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