From b2228fefc35ec787c33c0e0131ace8502c1ce5e6 Mon Sep 17 00:00:00 2001
From: ache <ache@ache.one>
Date: Wed, 18 Sep 2019 04:44:45 +0200
Subject: Install instructions

---
 README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 89 insertions(+)

diff --git a/README.md b/README.md
index 98437d4..9357192 100644
--- a/README.md
+++ b/README.md
@@ -3,4 +3,93 @@ mesms
 
 A ncurses based SMS manager
 
+Powered by [gammu](https://wammu.eu/gammu/).
+It's a third party application that manage Gammu folder.
 
+![Record of mesms](https://ache.one/res/mesms.gif)
+
+## Installation
+
+First of all, you should have a working gammu setup.
+Here is my Gammu setup:
+
+/etc/gammurc: 
+~~~
+[gammu]
+port = /dev/ttyUSB0
+connection = at
+~~~
+
+/etc/gammurc:
+~~~
+[gammu]
+port = /dev/ttyUSB0
+connection = at
+~~~
+
+/etc/gammu-smsdrc:
+~~~
+[gammu]
+port = /dev/ttyUSB0
+connection = at
+synchronizetime = yes
+logfile = /var/spool/sms/log
+logformat = textalldate
+
+
+[smsd]
+Service = files
+RetryTimeout=60
+MaxRetries=2
+
+OutboxPath   = /directory/youwant/to/sms/outbox/
+InboxPath    = /directory/youwant/to/sms/inbox/
+SentSMSPath  = /directory/youwant/to/sms/sent/
+ErrorSMSPath = /directory/youwant/to/sms/error/
+
+InboxFormat=detail
+OutboxFormat=detail
+~~~
+
+Note that **you must use the format `detail`** and service `file`**.
+
+Now, you can test the setup using `gammu-smsd-inject`
+
+~~~sh
+$ gammu-smsd-inject TEXT +33NUMBER -text "This is a test !"
+~~~
+
+A file should be created in the outbox directory.
+Soon it will be send and the file will be moved to the Sent directory.
+
+If so, congratulation ! You have a working gammu setup.
+Lets now install mesms to manage your SMS directory.
+
+### Install mesms
+
+Quite easy. It's a C software, you need gcc, make and git.
+
+~~~sh
+$ git clone https://git.ache.one/mesms
+$ cd mesms
+$ make
+$ sudo make install
+~~~
+
+Note: Theire is a AUR package. `yay -S mesms-git` should work too on Arch Linux.
+
+Now, you have to make a config directory. It should be `~/.mesmsrc`.
+
+~/.mesmsrc:
+
+~~~
+SMS_INBOX=/????/sms/inbox/
+SMS_SENTBOX=/????/sms/sent/
+SMS_OUTBOX=/????/sms/outbox/
+MMS_DIR=/tmp
+CONTACT_FILENAME=/home/user/.contacts.csv
+~~~
+
+Now you can execute mesms !
+
+Enjoy !
-- 
cgit v1.2.3