yetangitu/deltachat-core
1
0
Fork 0
mirror of https://github.com/deltachat/deltachat-core.git synced 2025-10-04 18:29:19 +02:00
Code Issues Releases Wiki Activity

some more refinements and typo fixes

Browse source
This commit is contained in:
holger krekel 2018-09-27 16:40:59 +02:00
parent 4d22bcd783
commit 690ba67c8b
2 changed files with 12 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -3,22 +3,18 @@
[![Build Status](https://travis-ci.org/deltachat/deltachat-core.svg?branch=master)](https://travis-ci.org/deltachat/deltachat-core) [![Build Status](https://travis-ci.org/deltachat/deltachat-core.svg?branch=master)](https://travis-ci.org/deltachat/deltachat-core)
The _Delta Chat Core Library_ is written in cross-platform **C**, The _Delta Chat Core Library_ is written in cross-platform **C**,
documented at <https://c.delta.chat>. documented at <https://c.delta.chat>.
Delta Chat Core is built as a C-library using the
[meson build system](http://mesonbuild.com).
## binary/distribution packages (work-in-progress) ## binary/distribution packages (work-in-progress)
There are work-in-progress efforts for creating (binary) packages which There are work-in-progress efforts for creating (binary) packages which
do not require the steps outlined further below: do not require that you build the library manually:
- [a libdeltachat-core-git archlinux package] - [libdeltachat-core-git archlinux package](https://aur.archlinux.org/packages/libdeltachat-core-git/>)
(https://aur.archlinux.org/packages/libdeltachat-core-git/>)
- [a Debian package](https://github.com/deltachat/deltachat-core/issues/299) - [Debian packaging](https://github.com/deltachat/deltachat-core/issues/299)
- [a Windows build](https://github.com/deltachat/deltachat-core/issues/306) - [Windows building](https://github.com/deltachat/deltachat-core/issues/306)
If you can help with advancing or adding to these efforts, be our guest. If you can help with advancing or adding to these efforts, be our guest.
Otherwise read on for how to get ``libdeltachat.so`` and ``deltachat.h`` Otherwise read on for how to get ``libdeltachat.so`` and ``deltachat.h``
@ -32,8 +28,8 @@ If you have installed ``meson`` in your environment check the version::
meson --version meson --version
You need to have version ``0.47.2`` at least. If you version You need to have version ``0.47.2`` at least. If the version
is older here is one recommended way of getting a better version: is older there is a recommended way of getting a better version:
1. uninstall your system-level ``meson`` package (if possible) 1. uninstall your system-level ``meson`` package (if possible)
@ -43,11 +39,10 @@ is older here is one recommended way of getting a better version:
``` ```
to check that you have "pip" installed. If not available, you to check that you have "pip" installed. If not available, you
might get it as a ``python3-pip`` package or similar. might get it as a ``python3-pip`` package or you could follow
[installing pip](https://pip.pypa.io/en/stable/installing/).
See also [installing pip](https://pip.pypa.io/en/stable/installing/) 3. then pip-install meson into your home-directory:
3. then pip-install meson:
``` ```
python3 -u -m pip install meson python3 -u -m pip install meson
``` ```
@ -55,7 +50,7 @@ is older here is one recommended way of getting a better version:
the ``-u`` causes the pip-install to put a ``meson`` command line tool into the ``-u`` causes the pip-install to put a ``meson`` command line tool into
``~/.local/`` or %APPDATA%\Python on Windows. ``~/.local/`` or %APPDATA%\Python on Windows.
4. run ``meson --version`` verify it's at at least version 0.48.0 now. 4. run ``meson --version`` to verify it's at at least version 0.48.0 now.
If the ``meson`` command is not found, add ``~/.local/bin`` to ``PATH`` If the ``meson`` command is not found, add ``~/.local/bin`` to ``PATH``
and try again (``export PATH=~/.local/bin:$PATH`` on many unix-y terminals). and try again (``export PATH=~/.local/bin:$PATH`` on many unix-y terminals).

54
python/doc/install.rst
View file

@ -1,54 +1,2 @@
building and installing deltachat .. include:: ../README.rst
======================================
This package provides bindings to the delta-core_ C-library
which provides imap/smtp/crypto handling as well as chat/group/messages
handling to Android, Desktop and IO user interfaces.
build
-------
.. note::
Currently the install instructions exist only for Debian based systems (Ubuntu etc.).
First you need to execute all the build steps to install the delta-core C-library,
see https://github.com/deltachat/deltachat-core/blob/master/README.md#build
install
-------
Presuming you have the delta-core library installed, you can then from the root of the repo::
cd python
pip install -e .
Afterwards you should be able to successfully import the bindings::
python -c "import deltachat"
running tests
-------------
Install the delta-core C-library and the deltachat bindings (see _Install)
and then type the following to execute tests::
pip install tox
tox
If you want to run functional tests that run against real
e-mail accounts, generate a "liveconfig" file where each
lines contains account settings, for example::
# 'liveconfig' file specifying imap/smtp accounts
addr=some-email@example.org mail_pw=password
addr=other-email@example.org mail_pw=otherpassword
And then run the tests with this live-accounts config file::
tox -- --liveconfig liveconfig
.. _`delta-core`: https://github.com/deltachat/deltachat-core