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

Update README.md with grammar tweaks #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

brandondrew
Copy link

I hope this is helpful. Feel free to hit me up with questions if any changes are not clear, or if you think I misunderstood your intent.

Describe the change

Just touching up the grammar for clarity & readability.

Why are we doing this?

Greater readability means less cognitive overhead is required for understanding.

I hope this is helpful.  Feel free to hit me up with questions if any changes are not clear, or if you think I misunderstood your intent.
Copy link
Owner

@piotrmurach piotrmurach 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 for the suggestions. I like them bar the first one. Though I leave room to be convinced. I'm curious to hear what lead you to change write to compose?

@@ -21,16 +21,16 @@

## Features

* Write slides in the **Markdown** with extended syntax.
* Compose slides in **Markdown** with extended syntax.
Copy link
Owner

Choose a reason for hiding this comment

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

I'm not convinced by the 'compose'. By using the 'write', I wanted to emphasise that the slides are created in a text editor. It feels as though the 'compose' is taking the concept in another direction and further from the intent. However, I'm willing to be convinced that this is a good choice in this context. Though, in practice, I haven't heard anyone use the word 'compose' when working on slides.

Copy link
Author

Choose a reason for hiding this comment

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

Different verbs go well with different objects. "Write slides" may not be syntactically wrong, but it definitely sounds awkward. If you want to use the word "write", I would say something like "Create slides by simply writing in Markdown".

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