From fe9ec0c54c5c0224bdce6b557fe1f4bf2acbc972 Mon Sep 17 00:00:00 2001
From: Vitalie Spinu <spinuvit@gmail.com>
Date: Mon, 31 Aug 2015 01:38:14 +0200
Subject: [PATCH] Squashed 'packages/company-math/' content from commit b585117

git-subtree-dir: packages/company-math
git-subtree-split: b585117b814d9c7474a50de5753526ebab7fa27f
---
 company-math.el         | 159 ++++++++++++++++++++++++++++++++++++++++
 img/latex-symbols.png   | Bin 0 -> 3355 bytes
 img/unicode-symbols.png | Bin 0 -> 3333 bytes
 readme.md               |  62 ++++++++++++++++
 4 files changed, 221 insertions(+)
 create mode 100644 company-math.el
 create mode 100644 img/latex-symbols.png
 create mode 100644 img/unicode-symbols.png
 create mode 100644 readme.md

diff --git a/company-math.el b/company-math.el
new file mode 100644
index 000000000..7d8efabf1
--- /dev/null
+++ b/company-math.el
@@ -0,0 +1,159 @@
+;;; company-math.el --- Completion backends for unicode math symbols and latex tags
+;;
+;; Copyright (C) 2015 Free Software Foundation, Inc.
+;; Author: Vitalie Spinu
+;; URL: https://github.com/vspinu/company-math
+;; Keywords:  Unicode, symbols, completion
+;; Version: 1.0.1
+;; Package-Requires: ((company "0.8.0") (math-symbol-lists "1.0"))
+;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;; This file is part of GNU Emacs.
+;;
+;; This program is free software; you can redistribute it and/or
+;; modify it under the terms of the GNU General Public License as
+;; published by the Free Software Foundation; either version 3, or
+;; (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;; General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program; see the file COPYING.  If not, write to
+;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth
+;; Floor, Boston, MA 02110-1301, USA.
+;;
+;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;
+;;; Code:
+
+(require 'math-symbol-lists)
+(require 'company)
+(require 'cl-lib)
+
+(defgroup company-math nil
+  "Completion back-ends for math symbols Unicode symbols and LaTeX tags."
+  :group 'company
+  :prefix "company-math-")
+
+(defcustom company-math-prefix-regexp "\\\\\\([^ \t]+\\)"
+  "Regexp matching the prefix of the company-math symbol.
+First subgroup must match the actual symbol to be used in the
+completion."
+  :group 'company-math
+  :type 'string)
+
+(defcustom company-math-allow-unicode-symbols-in-faces t
+  "List of faces to allow the insertion of Unicode symbols.
+When set to special value t, allow on all faces except those in
+`company-math-disallow-unicode-symbols-in-faces'."
+  :group 'company-math
+  :type '(choice (const t)
+		 (repeat :tag "Faces" symbol)))
+
+(defcustom company-math-allow-latex-symbols-in-faces '(font-latex-math-face)
+  "List of faces to disallow the insertion of latex mathematical symbols.
+When set to special value t, allow on all faces except those in
+`company-math-disallow-latex-symbols-in-faces'."
+  :group 'company-math
+  :type '(choice (const t)
+		 (repeat :tag "Faces" symbol)))
+
+(defcustom company-math-disallow-unicode-symbols-in-faces '(font-latex-math-face)
+  "List of faces to disallow the insertion of Unicode symbols."
+  :group 'company-math
+  :type '(repeat symbol))
+
+(defcustom company-math-disallow-latex-symbols-in-faces '()
+  "List of faces to disallow the insertion of latex mathematical symbols."
+  :group 'company-math
+  :type '(repeat symbol))
+
+
+;;; INTERNALS
+
+(defun company-math--make-candidates (alist)
+  "Build a list of math symbols ready to be used in ac source.
+ALIST is one of the defined alist in package `symbols'. Return a
+list of LaTeX symbols with text property :symbol being the
+corresponding unicode symbol."
+  (delq nil
+        (mapcar
+         #'(lambda (el)
+	     (let* ((tex (substring (nth 1 el) 1))
+		    (ch (and (nth 2 el) (decode-char 'ucs (nth 2 el))))
+		    (symb (and ch (char-to-string ch))))
+	       (propertize tex :symbol symb)))
+         alist)))
+
+(defconst company-math--symbols
+  (delete-dups
+   (append (company-math--make-candidates math-symbol-list-basic)
+           (company-math--make-candidates math-symbol-list-extended)))
+  "List of math completion candidates.")
+
+(defun company-math--prefix (allow-faces disallow-faces)
+  (let* ((face (get-text-property (point) 'face))
+	 (face (or (car-safe face) face))
+	 (insertp (and (not (memq face disallow-faces))
+		       (or (eq t allow-faces)
+			   (memq face allow-faces)))))
+    (when insertp
+      (save-excursion
+	(when (looking-back company-math-prefix-regexp (point-at-bol))
+	  (match-string 1))))))
+
+(defun company-math--substitute-unicode (symbol)
+  "Substitute preceding latex command with with SYMBOL."
+  (let ((pos (point))
+	(inhibit-point-motion-hooks t))
+    (when (re-search-backward company-math-prefix-regexp)
+      (delete-region (match-beginning 0) pos)
+      (insert symbol))))
+
+
+;;; BACKENDS
+
+;;;###autoload
+(defun company-latex-commands (command &optional arg &rest ignored)
+  "Company backend for latex commands."
+  (interactive (list 'interactive))
+  (cl-case command
+    (interactive (company-begin-backend 'company-latex-commands))
+    (prefix (unless (company-in-string-or-comment)
+	      (company-math--prefix t '())))
+    (candidates (all-completions arg math-symbol-list-latex-commands))
+    (sorted t)))
+
+;;;###autoload
+(defun company-math-symbols-latex (command &optional arg &rest ignored)
+  "Company backend for LaTeX mathematical symbols."
+  (interactive (list 'interactive))
+  (cl-case command
+    (interactive (company-begin-backend 'company-math-symbols-latex))
+    (prefix (unless (company-in-string-or-comment)
+	      (company-math--prefix company-math-allow-latex-symbols-in-faces
+				    company-math-disallow-latex-symbols-in-faces)))
+    (annotation (concat " " (get-text-property 0 :symbol arg)))
+    (candidates (all-completions arg company-math--symbols))))
+
+;;;###autoload
+(defun company-math-symbols-unicode (command &optional arg &rest ignored)
+  "Company backend for LaTeX mathematical symbols."
+  (interactive (list 'interactive))
+  (cl-case command
+    (interactive (company-begin-backend 'company-math-symbols-unicode))
+    (prefix (company-math--prefix company-math-allow-unicode-symbols-in-faces
+				  company-math-disallow-unicode-symbols-in-faces))
+    (annotation (concat " " (get-text-property 0 :symbol arg)))
+    (candidates (all-completions arg company-math--symbols))
+    (post-completion (company-math--substitute-unicode
+		      (get-text-property 0 :symbol arg)))))
+
+
+(provide 'company-math)
+
+;;; company-math.el ends here
diff --git a/img/latex-symbols.png b/img/latex-symbols.png
new file mode 100644
index 0000000000000000000000000000000000000000..781a46af0571050c0aeaf9d80e06a840fd3e6a5a
GIT binary patch
literal 3355
zcmcInc~BEs9)2NmC?lw-jG&+biYJH%2!W_v0aj4CFJVMQt^^1Wjv#SF8DUWIK)D?e
z91RJgKqP?#K}9)4VIVLe2_Z<hLVyq;Kx7+tXKS6Rt=gTc{iFMJcfI%e_3wM%(brBm
z+OAxou>t_F(hg;H3IO;?=(<5k4m#ru9W9^+jy-1QqNJq6;yLv~x68v(o>%}>UN0T6
zySr300r-w?XLZyiHdn|lL-*KdDf*ASy7Is_JbHbyb=&EXTBqJ&IUiH=OYO_%zfU{x
zUhO4fbI@KV|IJ}uDTETAq6GL+^7M+j=ARr?s%SpJCJPqdE8MeGv1O|+W^Hjl=ed4U
z=SZ}>8UXtzDFQ8M34z<iFwpNb00-|1niauKWR@z}oMfa8j(j<50SF84@c>9~O97bt
zzjtJ)x0(~$OWg8~)7Z&;08rVcOUt-=o-U#<3QPDVL{C*M&>N-mn^eW#rB5ByPPv`)
zjHw_oN6r`&$!6<E#sxU;;xu2il(?v9G5H`ZVTvS3gU0x8i66$ho`3qV?FO=%+{a$a
z*QhU1R0W0)zf`ep!bYb~dFm!4&d4x4#`waQyYPZ_(&gaUs^vArb4ed?&7S^%AV2a%
z?0T>Y<w?#zY<}VQs9wo-1^R3+3}hBEKDf)5nj-Ql#@z%j%JPjqLr-r-*Y=?E3hMf!
zqSl2aQ7|Et!W3kgD)4xqZhbP8yGYYdZE0a#f62Ihg75fC=jyQ67BH|r<Ri_CnyukV
zwbb$AXU+=iOA%8>fG{d)7G5nI?Q!Uvb`Fr0yhZ=a^FFdo69JAiE)}3f=*H#!nv2ov
zu`{1ZObJM~1)!O$#ATUh98dt^=%fzmG1nG@60u&eN1iJ1=jAg#D1zE5QseW{U`@t{
z8EN~wO_7eQv=MS~y3tP1ocguyU*T`D5R<3^Z5a5q*#g=qA03u9ieD>*xvjHHpBh(9
zYGpQ%0*5zn*zHZJk8d;5J3HP;#wIEyoY?k@DIJpeJj!Ao0PXhrVu=E6?+?^qUD9kT
zZ>F=sm+1oAw+03S`6t`3G)p<ZiE<_N^@7yO=Y9(u&Ne$0aKA8l7;kMzF*6iOG!orQ
z!|FioM!h@Ix?E%XS>mK8^HlXGvy#WS<D+umiCq*LCyq6<e}b7B)oX?U?41(>X?S+U
zr{7;1?XI*A4pnOwA97QZ1G-yDRctb@!sR$GSrmggRbhcPXDo`9;ASq$%fP7@JDZ*p
z!)i|7SSW8Tuo*KnKfGrk&E>Q)jeSQ41|08v?AZ&E=GMoau^yplSRSB~n~gPsQ~|2<
zQI_c5;%P^z2>?4gza<r;JCKf{$7i`9A<kzf4&-op+Ihx)HM#Qz0Bp4XT2n8PfR^Bu
zM4jW)E&Q}8`A?MHk;t0Rp5nQ){copQBAP+%wKa|Snpfl|Xk-cYZ?X6j?Kf43mu-;Z
zwpj<kd<p=HcJXK&s&`ku!o7mUm#V~w`kZ0@J7283EQrStXsrf@8UHHjzMhh%+y9vJ
zhYy;&7S1_8gaZ@nV_60+)-|--YB`PT!I6yL;_0z<%HE>sN}uEgUS^uCWdrFrZ{nh}
z)~kJwuUrGQzx+YL2<>SHDPvaNR}>s{z*iRGhZ!Onb>F0rM=6K4`j3QodcnDPZb#%t
zIvcfuI~r4%z8sh^%8j(`GNfR$<~6b)Ac~|$dqH%T0}UC{%wyGXf}X<#RYj=WTfZ&m
zf1^>{M_iUnz|}6sZ?sK#x#+RhI%1|kR@~%{d91Y(gd0VFD{jme`Iw5i8vRuEnD*`O
z2EHezjj;K`pK3Z9bYhgjcy+uH7d>-h=ky+{JaOGP(-7U5+crIXJh8fJe*9->V{AKg
zfjbr~NoXvxxY~8PCPNJT%jWj`RsW`bsG}-;aqdz^#C$omQhLgfb=n7$pV_GqIQ+ba
zEbRBIS89w+_hR21_GSMt0;%4ugHtj*sfa$_4^79<MmZBX{>;Obo5=?sdPn;dAR@eC
z?l=Naj9W0v+U_AR)*WBxlom#7@Xjjf7#O=O!GmWWmyP@m*05ZMH6sp4dd6zY8;<rP
zfJcclqvlW_=enU_c~YVBOn6r-3^?qc%4=2=vDgTXeFFcfAV%H-(x`fReHp{S7=i6W
zh$`pr#-?|^z03R3!%LHD;8t$>oa<WV)C(uboBE@1i$!}Rri?kk4$E!?C#Hs26ue?P
zp5lbOA2HbE{M5USrcq|lCRlyL!D`*?>!rC}Ju`j7MkLfY$+dzr^9w`oG!J(l9g%8{
zA!82u(&No0-vNTyY_~YiejsN#WJX5Vu6W2g2T*_2q73pAz@x#*&rFg)dkkr@APt${
zQ_9K5T7g=--@Y|A?kH1C+DpdWptPE&c0)LJBde<B4P_`m*a0cwzMkpf^jJmEbQX=<
zu?+f{=jFqANH)g>15J;F(|z&cC^<^RdCBLuvN%rgBt`P0>-fvJ=@T?+HUMpqAdRey
z@vYNKBsI-@8C>wGN(y+y;%tW`NpGl%z2#DAtXGiou5e%V(SnU_!rE<suuRWIu<OSv
z_N5@v+WAk0m>imF<`k^<%vTY_jg7m@)5#TyRZq|OxwpT*3<Jf`JCt2dViG=VtZY8q
zO%8p$ObNs}Trl@T@UD>3ch#?9N0{x*Jkg()b_c)+-|4ytSpSZi-;2n>9A^!0b1&S*
zv*%HdoP}_L&sUr9E@kQ<h2qB<W@izWa@=}Z19^!{4NIDmojec|XR{LzZW?FZc=!yX
z4kG_*R#=JvpiL6KSVkP0>|pJ%l>@mb$g}>LNa6=#lHwQXrm;Bee*5-8H+3ehfrUlN
z1OLu5S)#`?qLGj5wY1p>bRO!0n`&4Z6kQxbxMS0OrVCZlQ$b&;=f>6ubn`=pt`)dB
znT-asE229(1o*I0&Vdi1V-|=e2<vNajJUL%oVShD!vd(~XZKkSEg=`zMdtI|-4vye
z<6d%l2Pd5Kx_hp>qw;hq@$#pbNc@+z8|-y?)_wlEUDlD_2$i>@yeGnr97}k?j2L$0
zkb;m!YKl%Tus!gm19H5^1j~M7q%sIk&TnQ?;S^Jg;vp6@Bk;;$%$;#2)!rbt)tnj#
z2yu2Hs<x!mc-F)jPjeQ_<b}TN-$ZgC4y7-Cg9}Y2rSCSutJ;Rm#OBE4=vQ|N4_1z)
z5}@>Qc{<$1rtAG`cKyjH2C?W<d0chaD9>cVchCIsD;0$4aB##%<sDvUunDhgJpd<!
z&Z;Q>DfJCTNhhIDkb+Fgi`0d@;!lZ?Dc*E_HK!hbzB>sS;FB&2cfqH_!E^N{JhCRq
zFQsyPcCdKEdn5Zf&R(!Pvx;4`Y8Lpvhd|ukDXC%4jZk@ad0A=<3N2(L7*!DM-2Z|x
zVIVidVMQC^qe3VERCo*|;IQo;S?)4C4vY11#_L1==U}4BibgCn4nGJ%Qz9<*7V-;+
zshf@JVl(Bz1&{xTNN4{WzW)N}QmaPW+PKbI+SO7s1R6cV`x4;Z{+UQgnN|RZdq?ME
zMk0Org4M?(AmzL{$yt@Lp+n6KAEPKwf2e;5r@ea!PIxo?9#1k0C-MWb>4}@--0q8Q
zmM2YIiLiY{k=?}(S=DZN+Qp2&IQI$wXZt_ETjOfp^1BJv2f4!}3QgI{fz=x6O_4K~
z+*Q;4svWsZ^b3(93tMG-PZpoD8lz!SN7f_EC!t<LHY3CI?g2-%6okBAe|~mbhniA2
zc+uUVFi0HB>Z*_Eqj^o|q+YKeq<d><9(0UzcldPvHLfB#O<LEiUb@g-4+C)~o5kr5
z48$$WqY24@RuI|<U26UfY?pzk`@J$y-Xh*(9e`%uf;4R{miGESOCIV_4l$XqA9Cma
dA^XoHO&#-AYFf7482YyWcGiwo<YWFn{vAinf*t?>

literal 0
HcmV?d00001

diff --git a/img/unicode-symbols.png b/img/unicode-symbols.png
new file mode 100644
index 0000000000000000000000000000000000000000..050e6fe249f8906189458dd509776263f7f45716
GIT binary patch
literal 3333
zcmcInSy)ro8r><QM2Hs)R7Pv-#1sJqK?ovFs0>mJf?%K#5F>*FAP^vJ#EOWB3L%UR
z1;ij>XqW;a%nAf72nmD`28l(&7zQDR+@rm>_q#8B>%;lau=m;DK5MOit?wkbI2}_~
z(o_NfC_5ZK><WO)Y3RC5@hhlC>~TUtCz)%99NZKY6}h9%Bhc-J(BmH008nZEe85r-
zRI~ut_}t;Jo!gD9X`V?J_o$}4&n4fj47>Yo@HUsLfQ|ZzBFkB@wL76Vj$D!5t#SNC
z*48kUO|W|%vegGi+@$I^6Xx%0-`n*-)z${#<+9CEyIua%Smu_6P^)a+xQ`f7VI@Ku
zm?5}fZ4Q8tUmi?hMFP+)y1aHjA9`GG`)N+nWM6ao+KEbD_Jh~~ex^6Bq;O4Mfjb$l
zW))i8aG*|aN%}n?;0oLE-uYWLp2fBmloln*O_GRqPb7?b3&{;M5nCpo2_N&cBse`F
z0|HG#S*S98<d*+%v1C?HH;uJ7ap(6bQ>w8xpekl_7$Y{GicwAU%&#f=Xu<KMU^Im0
zt@1SZnb(V0_w72DU*ee@QhdrvW4!!IS|VLC3nS!N<L*!_$`Y;wI10|q#?43CKX-p5
z(Hvl2cT_!5+54tH#w-%ON?4$^YHDX`dkiQ8pOd{<`g<n<4y7WfD4*$S4+#9G-AU+)
zOZG6gziTAx@j>5gaI%0><jRRPbjAy%cO^1AsQa4E5(7IXZyi<yIErVJ$$m02Nsfrc
z6N$;?MyQNhVGpmon0C7%)ffQc2{P51OpSdvQ&e-Bm6F(;&FbkH+4yR0bLHtO^a?I_
zDU)=-_L&_RQO)bLh&JVKH^$Gr4$4@er*?aqn|mlJgVH_}Wnw5WlK5Ty!vLcLl%g$L
z2*tJ$Nkbk3f|0we*XeuaOXE1(*%?pX_+<Q$x(0mAdb=-?@unE5I2d+pG#%d89Isqs
za-&7)iS0nP2Po%of)`~5I4_3R#5#0zO{Mfr+IskCu|f1#plB45MC-Cna+?voapDmR
z5bS7JIwT5GrvliNTj~u6AK$J5F!u1TLW$xBn@t626P*(bYA3?yESXqDo>ny4tG=Nz
zF)CsWR7WB%?3UIpu`^<p%7?iX&+1hGC;mkzJ8nLhwHu3kr<3S6q47~&HDJ_p;=qY+
zrChTvNkUDz|EF5Od|9Z&&BkjTd$DeGiKK9Qfu@g?NScVdt{wQ~4VYv3{5tch)8Fh-
zeil~{Z4%NMB}@wPE({SOqlCX`YK0;<swXc!nPQ$L#-G#0_aVVhW<n<^>G{lJedp_c
zjUHdSrrvGDGG6G|xTD(tQc0CKARLV-_r@OU?>+?xH}c!U15ODjl?`!C#Q8j(&LEMU
z?_5Okleq;sbqQ?#YJ8E@Ud=zW3$5FrH+24)7AX1Q3~s;tPEnq8@}BZ*Wqm4>=Zc2i
zN!ftDBalA|^I?CHL&&nr$a1x>DfR2LC}GFQ<qk*<CYE-az*(=|qL%c|h!BB9N3H9_
z`f%P}z@ZKX(6Y`bw72_H<m20MO9(CPOeeMcwdo^%Qn6oGd2p@NekpExtzXIAp%S-#
z<mK<mfKxabKs$vZhnQlGR6i;q63JIyLRwg3O=J(9vSs|5SGCv?SxPM_4nI2l!s~0-
zoNujWF>cjbAk<c+pf~U`fBwc$nZX|aLf6vLKrn-z<`@f8Ao4Gsv7yL?zxZ@V1yt#^
zhQq*^Sp^)@#TRk>vjr0*5HGRbFC{G_7;}qxhJ6cBHnQMs(_sO9PaO<|!gEq1>ep7O
z#_woa)Yx_0G%6@G0nUp>z<}#!GIe$DvUg5cY>X&!(5K&j^-z3W;;jB++}xvu7#6Oa
zFXV*u>7pYo!HA0E1x9fN=~gm){D`K@=NHyWdEaQGy1LqXoF|Ig<>4Qq&khJKSjZ!G
z4QYUb{AN7E-By~Ke_uFm?LpjEaKZPYVc)*GhCj9huqs}~EYW`tsR+eDR&a?ut)vcs
zc%Mx!Qs4e5U`nd^ods7nfT3jCa8nBUcXhJ9MZZs+d(F0A7mAKpS=v7l1!U7sya$AX
z=t2?g$-5y1(ndjg10d1R^^{Fw<JnPbk#77CRY*W!G)-RD<VINQRtlBMBT;(5rJ|o>
zOfiM%$(o2|hYAOU5wQTQI0(1~mI&}X;IanTiXtQap~48z@){4_|C^Sxv$K|0FkEl;
z;=%N2S@6}s^DcINo&C4^Fi?`wXT~25y(ojp+NKAX!<Vgcshh;=yJ6~@9(m2XTD}4Y
zO55=aL!Uf71uVuLUi+rEx7XD%?<m(=JENeWX9xud+>$ZPd%-Fgjr7j<GN9_t8B@%;
zkSS7Im;QoZU&FdDacA1en0U2jBE1HA%-QXO3|RJgX@$`c3$llEs)U#LMPuoH^agK<
z>vq7@<;|Fp+e|%J2}Bc<pl@w<;PArhfFSXVK=Cz4cL$k`^ya_-x}+s~zwsl#w$k~5
z_1#N$F1`qGJ4k^XLOhs%N)a?yjNuvAby|hJ0aM9_0mR11LrIM(0KmNJyDavrWEzVd
z-Dmw1jr_eX&JC50j=$b)^IQ({Lz*f7Y++GshBvERvg6#V;pKA|e;r~pV1N%Bt<A0b
zG^u}X+4ua^9Xwzf7d=?@m#y+v?~z3TpPgxXT-LC=KhzD(zL!f3-i~F1j;F&KVAETD
zvU3mujN}{Ut~T~B0}zgD34_dhNbzrZXPn7-T}#e&iaSq-i|3}<7%w^;F!vRTV4!*D
z=TbRa$}3yp<5$NjZHsw{XYea5(qx++ad-zPdGv}rt6G_*!DX^1Y7M0@u(*ZG+a7NN
zMhxet@UymQ4QpW#-aHa^XMWhe0XX#KBV?q`Q`Rk9TR2S%i>32pM1C2fvScl@7jWRF
zgsR9CRA|&oQu^mw!&7-qzRn{u;Da1hWHb~009|uyyk_Dk7+L0p2q=cayfV3RR?uOl
zUYvMby#@w`%ET<ZNVnx_mOK!io?FESnjp_TPw89rCrOH*>U7sdSpY(v;`#R{%e~Q@
zjvq0;A(aMNN9xudUy2CpI|d#L{}+d*P0j_jR9?J6dg+hjTx$K<LNka8Sv{^Cc$@;I
z;ml8+mA3w~Fz|kGMe|;WRI);&hl)_*4}&%U6gy}Cx78RBLi4K~ep=Rsysdy~zAb=p
z(lAE@28xdhWWenZ{!}>bx*EMwZ@5qRfuViCL}xVS1FgEEO@rE-9Kx5DT~Po88>O68
z-Q0Si>bV+kPG9f^g$R{yOt|Ij+$X=ad3{|>t-2Tx92(3p8QkI68|>}XhCO-o_MV$7
zi=(_{idET7QmO<1d2%<D>X<nz%ulJ+fBKQT*@NiuQ_x2A<@C6YiID?`l8U-2NoD-;
zL^dzC6^{asouK&{(`Ak4)x}EDGH$Xk!hwkW*-lvTy|(c*Z}NC9pUNX<t_--dXCPmW
zX=sCT;^GCUS);f9DWQ0OQ$6rzZxR$3p@`1|A0Z6tto^qDpP&>o{`O#NWYh*|Or0D;
z8fHjaI>KRus0Myr|MzP2b%VF^5n&krXhb&#rCfK@NU}aR|7bmhNFTh0aB#dbrz&Hy
zG)ChnfVc2JAzJYI4@B%&jTl>QpHTB;8UQ54FT#RQ&f8a8>W%IB*{f!LubW(_iY~Vg
z@5!Mc7nFl#z}*cw5VaQ@lc&`?&y%^1jUDY*f0>tuLtSJZT2G!Gnv8m=^j&%WA27gH
z!(X;A68ORQm04jN2arayetC?`Y3D_ghj>tQ0`C9G%<o7^?S5>lj7RHl&ViE^$Ur4f
zwfUFc$-Nb`H>`sPQZ3h4C4)9q_sm6(3XE>X;8P30WWiAtTB!@VUyz|TLsaB^&Rl*M
rJ2agt4_xg2(%3&|?0>&9Ln@<&YcZbuc(n`qkpT`zoDLTs^7;AShNU8;

literal 0
HcmV?d00001

diff --git a/readme.md b/readme.md
new file mode 100644
index 000000000..cc471942e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,62 @@
+This add-on defines three *[company-mode](http://company-mode.github.io/)* backends:
+
+* `company-math-symbols-latex`	- math latex tags (_by default, active only on latex math faces_)
+
+      ![symbols](https://raw.github.com/vspinu/company-math/master/img/latex-symbols.png)
+
+* `company-math-symbols-unicode`	- unicode symbols (_by default, active everywhere except math faces_)
+
+      ![math](https://raw.github.com/vspinu/company-math/master/img/unicode-symbols.png)
+
+* `company-latex-commands` 		- latex commands 
+
+## Usage ##
+
+Start math completion by typing the prefix <kbd>`\`</kbd> key. To select the
+completion type <kbd>RET</kbd>. Depending on the context and your configuration
+unicode symbol or latex tag will be inserted.
+
+## Activation ##
+
+Install from [MELPA](http://melpa.milkbox.net/) repository.
+
+You can either register each backend globally:
+
+
+```lisp
+
+;; global activation of the unicode symbol completion 
+(add-to-list 'company-backends 'company-math-symbols-unicode)
+
+
+```
+
+or locally per emacs mode:
+
+
+```lisp
+
+;; local configuration for TeX modes
+(defun my-latex-mode-setup ()
+  (setq-local company-backends
+              (append '(company-math-symbols-latex company-latex-commands)
+                      company-backends)))
+
+(add-hook 'TeX-mode-hook 'my-latex-mode-setup)
+ 
+```
+
+## Customization ##
+
+Set `company-tooltip-align-annotations` to t in order to allin symbols to the
+right as in the above previews.
+
+By default unicode symbols backend (`company-math-symbols-unicode`) is not
+active in latex math environments and latex math symbols
+(`company-math-symbols-latex`) is not available outside of math latex
+environmnts. You can use the following variables to adjust this behavior to your
+liking: `company-math-disallow-unicode-symbols-in-faces`,
+`company-math-allow-unicode-symbols-in-faces`,
+`company-math-disallow-latex-symbols-in-faces`,
+`company-math-allow-latex-symbols-in-faces`.
+ 
-- 
2.39.2