stv0g/telegram-purple
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Change README

Browse source
This commit is contained in:
mjentsch 2015-01-10 12:11:03 +01:00
parent 7353fdcf5c
commit a1feffc841
1 changed files with 49 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

100
README.md
View file

@ -14,8 +14,23 @@ The plugin is based on the library [Libtgl](https://github.com/vysheng/tgl), whi
* Discover buddy state and info
- Profile Pictures
* Download and use profile pictures
- Adium Plugin
- Display Geo-Messages
- Display Pictures
- Adium Support
# Usage
## First Login
After succesfully completing all steps mentioned in the installation instructions, you should restart Pidgin to ensure that the plugin is loaded. When everything went well, Telegram should show up in the account manager:
![Create a new Telegram account](http://h2079792.stratoserver.net/telegram-purple/res/install-1.png)
The username is your current phone number, including your full country prefix instead of a leading '0'. For Germany, this would be '+49' for example. Telegram will verify your phone number by sending you a verification code via sms. You will be prompted for this code, once that happens.
![Provide a phone number](http://h2079792.stratoserver.net/telegram-purple/res/install-2.png)
Now you should be able to see all your contacts and chats in your buddy list and send/receive messages.
## Using secret chats
@ -25,11 +40,12 @@ One caveat of secret chats in Telegram is that they can only have one endpoint,
Self destructive messages will be ignored, since I don't know any way to delete them from the conversation and the history.
### Confirming the key authenticity
Click on the buddy in the buddy list and click on "Show Info" to visualize the key fingerprint.
![Confirm key authenticity](http://h2079792.stratoserver.net/telegram-purple/res/key.png)
### Initiate secret chats
To initiate a secret chat from Pidgin, click on a Buddy in the Buddy List and hit ``Start Secret Chat''
@ -39,37 +55,6 @@ To initiate a secret chat from Pidgin, click on a Buddy in the Buddy List and hi
If you delete a secret chat from the buddy list, it will be terminated and no longer be usable.
# Changelog
Warning, this version is mainly for development and testing and NOT for productive use. Even though it already provides basic features, you should still expect bugs and crashes when running it.
When encountering a crash or some other bugs, please report it to us, preferably together with a backtrace of the crashed application [https://developer.pidgin.im/wiki/GetABacktrace]
## Version 0.6
- Support for secret chats
## Version 0.5
- Display incoming photos
- Respect received user and chat property updates
- Support changing own profile picture
- Support adding new contacts
- Display service messages
- Works with libpurple proxy settings
## Version 0.4
- Use latest version of libtgl
## TODO:
- Picture, audio and video messages
- File transfers
- Geo-locations
## Platform Support
We only provide an installation guide for Linux right now, even though it should be possible to compile this plugin on other platforms. If someone manages to create a working Windows or BSD-build please let us know.
@ -119,19 +104,6 @@ On Debian-based systems you can use:
sudo make install
# Usage
After succesfully completing all steps mentioned in the installation instructions, you should restart Pidgin to ensure that the plugin is loaded. When everything went well, Telegram should show up in the account manager:
![Create a new Telegram account](http://h2079792.stratoserver.net/telegram-purple/res/install-1.png)
The username is your current phone number, including your full country prefix instead of a leading '0'. For Germany, this would be '+49' for example. Telegram will verify your phone number by sending you a verification code via sms. You will be prompted for this code, once that happens.
![Provide a phone number](http://h2079792.stratoserver.net/telegram-purple/res/install-2.png)
Now you should be able to see all your contacts and chats in your buddy list and send/receive messages.
# Troubleshooting
If you encounter problems running this plugin and you have updated from an older version,
@ -144,11 +116,8 @@ To clean all your user files run:
sudo make purge
# Adium Plugin
## Bundle
All Adium bundle releases are now provided as a [Github Release](https://github.com/majn/telegram-purple/releases)
The bundles were tested to work on OSX 10.8 to 10.10. If it doesn't work on your installation
@ -157,9 +126,9 @@ please send your Adium crash log (which you can find in ~/Library/Logs/Adium 2/)
## Building with XCode
1. Compile the source of your current Adium version and add the created frameworks to the Adium-Telegram build path.
2. Build the tgl submodule
2. Build the tgl submodule.
2. Get zlib and libcrypto.a and provide it somewhere in your build path.
3. Build the XCode-Project and execute the created bundle
3. Build the XCode-Project and execute the created bundle.
# Unicode Emojis for Pidgin
@ -168,6 +137,35 @@ The Telegram phone applications for iOS and Android make use of standardized Uni
does not display those smileys natively, but you can install a custom smiley theme like (https://github.com/stv0g/unicode-emoji) or (https://github.com/VxJasonxV/emoji-for-pidgin) and activate it under Settings > Themes > Smiley Theme.
# Changelog
Warning, this version is mainly for development and testing and NOT for productive use. Even though it already provides basic features, you should still expect bugs and crashes when running it.
When encountering a crash or some other bugs, please report it to us, preferably together with a backtrace of the crashed application [https://developer.pidgin.im/wiki/GetABacktrace]
## Version 0.6
- Support for secret chats
- Receiving geo messages
## Version 0.5
- Display incoming photos
- Respect received user and chat property updates
- Support changing own profile picture
- Support adding new contacts
- Display service messages
- Works with libpurple proxy settings
## TODO:
- Picture, audio and video messages
- File transfers
- Geo-locations
# Authors
Telegram-Purple and Telegram-Adium were written by: