diff --git a/README.md b/README.md index 29ef917..d4301e0 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,30 @@ Documentation for MTproto protocol is available here: http://core.telegram.org/m ### Installation -Just run `make` +#### Linux -#### Requirements +Just run + + $ ./configure + $ make + + +#### Mac OS X + +The client depends on [readline library](http://cnswww.cns.cwru.edu/php/chet/readline/rltop.html) and [libconfig](http://www.hyperrealm.com/libconfig/), which are not included in OS X by default. You have to install these libraries manually, e.g. using [Homebrew](http://brew.sh/). + + $ brew install libconfig + $ brew install readline + $ export CFLAGS="-I/usr/local/include -I/usr/local/Cellar/readline/6.2.4/include" + $ export LDFLAGS="-L/usr/local/lib -L/usr/local/Cellar/readline/6.2.4/lib" + $ ./configure && make + +Thanks to [@jfontan](https://github.com/vysheng/tg/issues/3#issuecomment-28293731) for this solution. + +#### Other UNIX + +If you manage to launch it on other UNIX, please let me know. -Currently only Linux OS is supported. But if you manage to launch it on OS X or other UNIX, please let me know. ### Usage @@ -26,14 +45,27 @@ By default public key is stored in the same folder named tg.pub: #### Supported commands: -* chat_info -* contact_list -* dialog_list -* help -* history -* msg -* send_photo -* send_text -* send_video -* stats - +* **msg** \ Text - sends message to this peer +* **contact_list** - prints info about users in your contact list +* **stats** - just for debugging +* **history** \ [limit] - prints history (and marks it as read). Default limit = 40 +* **dialog_list** - prints info about your dialogs +* **send_photo** \ \ - sends photo to peer +* **send_video** \ \ - sends video to peer +* **send_text** \ \ - sends text file as plain messages +* **chat_info** \ - prints info about chat +* **user_info** \ - prints info about user +* **fwd** \ \ - forward message to user. You can see message numbers starting client with -N +* **rename_chat** \ \ +* **load_photo**/load_video/load_video_thumb \ - loads photo/video to download dir +* **view_photo**/view_video/view_video_thumb \ - loads photo/video to download dir and starts system default viewer +* **search** \ pattern - searches pattern in messages with peer +* **global_search** pattern - searches pattern in all messages +* **mark_read** \ - mark read all received messages with peer +* **add_contact** \ \ \ - tries to add contact to contact-list by phone +* **create_secret_chat** \ - creates secret chat with this user +* **rename_contact** \ \ \ - tries to rename contact. If you have another device it will be a fight +* **suggested_contacts** - print info about contacts, you have max common friends +* **visualize_key** \ - prints visualization of encryption key. You should compare it to your partner's one +* **show_license** - prints contents of GPLv2 +* **help** - prints this help