Skip to content

polish Install section of README.md for clarity #147

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

Merged
merged 1 commit into from
Dec 22, 2014
Merged

polish Install section of README.md for clarity #147

merged 1 commit into from
Dec 22, 2014

Conversation

rickhull
Copy link
Contributor

Minor polish items to minimize awkwardness and maximize clarity

  • add backticks for monospace code/command highlighting
  • 80ch line length
  • emacs initialization file rather than assume .emacs

@tonini
Copy link
Contributor

tonini commented Dec 20, 2014

Thanks @rickhull for your contribution. <3

But I thought already about the Installation part in the README and thinking more about something like this: https://github.com/tonini/alchemist.el#installation

It a kind of installation guidance build from cider and takes the best informations needed together.

Would you like to update it more in that direction?

@rickhull
Copy link
Contributor Author

@tonini Yeah, that seems sensible. But I'm probably not the best person person to make sweeping changes. I'm just a very new user of elixir-mode who had trouble with the install process. That said, I am always interested in better, clearer documentation, and I can dive right in to making small tweaks and edits.

How about we merge this one for now, and I'll take a stab on the revamp in a subsequent PR?

tonini added a commit that referenced this pull request Dec 22, 2014
polish Install section of README.md for clarity
@tonini tonini merged commit 2781086 into elixir-editors:master Dec 22, 2014
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