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.rst #191

Merged
merged 2 commits into from
Apr 11, 2018
Merged

Update README.rst #191

merged 2 commits into from
Apr 11, 2018

Conversation

pohly
Copy link
Contributor

@pohly pohly commented Apr 11, 2018

This makes the main README.rst a better starting point for new users:

  • remove obsolete comments (afew isn't "a young project" anymore)
  • link to full documentation
  • fixes some formatting issues

Merging this will close #23, which probably could have been closed already a while ago. The documentation under "docs" was good enough for me to get started.

pohly added 2 commits April 11, 2018 09:08
The comment about "afew is quite young" is from 2012 and no longer
accurate. The NEWS.md file seems unused. Only the IRC channel
information is still accurate.
The instructions in README.rst duplicated some of the information in
the more complete docs, but not enough to really get started using
afew. It is better to avoid duplication and refer new users directly
to the full documentation.

The README.rst installation instructions were slightly more complete
and recent, so they were copied to the
docs/sources/installation.rst.

While at it, fix broken links in the rst markup.

Fixes: afewmail/afew/afewmail#23.
@flokli flokli merged commit 6ee2603 into afewmail:master Apr 11, 2018
@flokli
Copy link
Member

flokli commented Apr 11, 2018

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
Development

Successfully merging this pull request may close these issues.

write documentation
2 participants