Merge pull request #73 from piyueh/update-doc

update README
This commit is contained in:
Rodolfo García Peñas (kix) 2021-06-12 16:11:31 +02:00 committed by GitHub
commit be752838c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -13,7 +13,9 @@ Upstream status (`next` branch):
[blog]: https://www.offlineimap.org/posts.html
Links:
* Official github code repository: [offlineimap]
* Official github code repository
* for Python 2: [offlineimap]
* for Python 3: [offlineimap3]
* Website: [website]
* Wiki: [wiki]
* Blog: [blog]
@ -22,14 +24,13 @@ Links:
***"Get the emails where you need them."***
[Official offlineimap][https://github.com/OfflineIMAP/offlineimap3].
## Description
OfflineIMAP is software that downloads your email mailbox(es) as **local
Maildirs**. OfflineIMAP will synchronize both sides via *IMAP*.
## Why should I use OfflineIMAP?
IMAP's main downside is that you have to **trust** your email provider to
@ -61,11 +62,11 @@ GNU General Public License v2.
You should first check if your distribution already packages OfflineIMAP for you.
Downloads releases as [tarball or zipball](https://github.com/OfflineIMAP/offlineimap3/tags).
If you are running Linux Os, you can install offlineimap with:
If you are running Linux, you can install offlineimap with:
- openSUSE `zypper in offlineimap`
- Arch Linux `pacman -S offlineimap`
- fedora `dnf install offlineimap`
- Arch Linux: through AUR package [offlineimap3-git](https://aur.archlinux.org/packages/offlineimap3-git/)
## Feedbacks and contributions
@ -98,9 +99,6 @@ Bugs, issues and contributions can be requested to both the mailing list or the
* Python v3+
* rfc6555 (required)
* imaplib2 >= 3.5
* If you encounter an error that `cannot import name 'IMAP4' from 'imaplib2'`, it means that you need to install imaplib2 from the git repository.
* First, clone https://github.com/jazzband/imaplib2.git to your local computer.
* Then, enter the directory of the repository, run `pip install .` or `pip install --user .`.
* gssapi (optional), for Kerberos authentication
* portalocker (optional), if you need to run offlineimap in Cygwin for Windows