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 for Mac OS X #5

Merged
merged 4 commits into from Mar 4, 2013
Merged

Update README for Mac OS X #5

merged 4 commits into from Mar 4, 2013

Conversation

ghost
Copy link

@ghost ghost commented Feb 27, 2013

The README.md file omitted instructions for how to install the Aspell library for Mac OS X users.

@ghost ghost closed this Feb 27, 2013
@ghost ghost reopened this Feb 27, 2013
@yorickpeterse
Copy link
Owner

Is there a particular reason why the installation command is mentioned both under "Requirements" and "Usage"? Personally I think it's better to have a separate section in the README (under "Requirements") that lists the installation commands for Aspell. Something like the following:

## Installing Aspell

* Arch Linux: `sudo pacman -S aspell`
* OS X: `brew install aspell --lang=en`

The way it's currently done in this patch is a bit confusing.

@ghost
Copy link
Author

ghost commented Feb 27, 2013

Hi, I wasn't sure about the proper convention. I agree that it is better in just the requirements section.

@ghost
Copy link
Author

ghost commented Feb 28, 2013

Should I submit another pull request with your suggestion? This is my first
pull request, and it would be awesome if I actually contributed something
that would be meaningful enough to be approved.

On Wed, Feb 27, 2013 at 4:24 PM, Yorick Peterse notifications@github.comwrote:

Is there a particular reason why the installation command is mentioned
both under "Requirements" and "Usage"? Personally I think it's better to
have a separate section in the README (under "Requirements") that lists the
installation commands for Aspell. Something like the following:
Installing Aspell

  • Arch Linux: sudo pacman -S aspell
  • OS X: brew install aspell --lang=en

The way it's currently done in this patch is a bit confusing.


Reply to this email directly or view it on GitHubhttps://github.com//pull/5#issuecomment-14200868
.

@yorickpeterse
Copy link
Owner

You can just use this pull request for it, there's also no need to rebase/reset anything :)

@yorickpeterse
Copy link
Owner

Why is the note "Dutch and Greek language packs for Aspell (only when testing the code)" under "Installing Aspell"? It's a requirement, not an installation step.

@ghost
Copy link
Author

ghost commented Mar 3, 2013

I initially thought that having all information regarding Aspell
installation in one section was correct. I now see how this presumption is
incorrect. I just moved the bullet point on language packs from Installing
Aspell back to Requirements.

On Sun, Mar 3, 2013 at 1:50 PM, Yorick Peterse notifications@github.comwrote:

Why is the note "Dutch and Greek language packs for Aspell (only when
testing the code)" under "Installing Aspell"? It's a requirement, not an
installation step.


Reply to this email directly or view it on GitHubhttps://github.com//pull/5#issuecomment-14352258
.

yorickpeterse pushed a commit that referenced this pull request Mar 4, 2013
Update README for Mac OS X
@yorickpeterse yorickpeterse merged commit 8eacc24 into yorickpeterse:master Mar 4, 2013
@yorickpeterse
Copy link
Owner

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants