From 2cab0490d5f8699f64c560b9c1299af25c5bc0a8 Mon Sep 17 00:00:00 2001 From: Jonas Schmidt <43679965+schmidtjonas@users.noreply.github.com> Date: Fri, 7 Aug 2020 23:18:19 +0200 Subject: [PATCH] changed README (#299) * changed README * changed readme again --- README.md | 45 +++++++++++++++++++++++++++------------------ 1 file changed, 27 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 8a0493bbc..4ad0009fc 100644 --- a/README.md +++ b/README.md @@ -10,27 +10,15 @@ Coveralls github branch Coveralls github branch - + ## Overview + TelegramClient is a **Squeak-Client** for the widely used Telegram-Messenger. It aims to provide features such as Authentication, Contacts, Message and Media sending and a minimal UI as well as as a Zen-mode and receiving messages in the background. *This Project is part of the "Softwaretechnik" Lecture 2020 at the Hasso Plattner Institute.* -## Installation -Make sure you have the current version of Squeak installed. -* Step 1: Install the Squeak Git Client and clone this repository. For the trunk clone develop, for the latest stable release choose master. -* Step 2: Install the Squeak FFI Workload. To do so, open the Workspace in Squeak and execute the following command: `(Installer repository: 'http://source.squeak.org/FFI') -install: 'FFI-Pools'; -install: 'FFI-Kernel'.` -* Step 3: Downloading the required native TDLib Binaries for your system: This should happen automatically. Alternatively you can download them here: On Windows you have to download [tdlib_windows.zip](https://github.com/hpi-swa-teaching/tdlib). For [Ubuntu 18 lts](https://github.com/hpi-swa-teaching/tdlib/actions?query=workflow%3A%22Tdlib+Ubuntu+Build%22) select the latest successful run of the pipeline and download the single artifact produced by the respective pipeline. We currently don't support MacOS yet, to find out more about this check our [wiki](https://github.com/hpi-swa-teaching/TelegramClient/wiki/Difficulties-and-Tips). -* Step 4 (Manual download only): Place the unzipped binaries inside of your squeak image inside the 'Resource' folder. -* Step 5 (Windows only): Install the [Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019](https://aka.ms/vs/16/release/vc_redist.x64.exe) - -Alternatively, check our [release page](https://github.com/hpi-swa-teaching/TelegramClient/releases) for an online installer in the form of a sar file. In that case you just have to follow steps two and five. -## Running TelegramClient -In a workspace window either execute the command `TCUTelegram newWithTCCCore` or click the Telegram entry in the Apps dropdown menu. The menu is only available if you already started the app once or installed the app via a release sar file. - ## Features + @@ -74,8 +62,29 @@ In a workspace window either execute the command `TCUTelegram newWithTCCCore` or
-## Resources for following groups -We have developed a [Project-Guide](https://github.com/hpi-swa-teaching/TelegramClient/wiki) in our wiki page, which contains the most important information to continue developing the TelegramClient. Feel free to add new information to the wiki. +## Running TelegramClient + +We currently only support Squeak 5.3. + +1. Install the last compatible FFI version. For Squeak version 5.3 use `Metacello new configuration: 'FFI'; load.` to install it. + +2. Check our [release page](https://github.com/hpi-swa-teaching/TelegramClient/releases) for an online installer in the form of a sar file. Install this sar file in your Squeak image. + +3. Click the Telegram entry in the Apps WorldMenu or execute the command `TCUTelegram newWithTCCCore`. The menu is only available if you already started the app once or installed the app via a release sar file. + +For further information or manual setup take a look in our [setup +guide](https://github.com/hpi-swa-teaching/TelegramClient/wiki/Setup-Guide). + +## Development + +### Wiki + +The [wiki](https://github.com/hpi-swa-teaching/TelegramClient/wiki) has a lot of useful information for continuing the development of this project. Feel free to add new information to the wiki. + +### Releasing + +Pre-Releases are created automatically whenever a commit is added to the develop-branch. Releases should created before each client meeting and can simply be done by merging develop into master. ## Our Group -Group 13 of the 2020 SWT I module incuded [Rohan Sawahn](https://github.com/rohansaw), [Jonas Schmidt](https://github.com/schmidtjonas), [Frederik Wollny](https://github.com/Freddy200), [Stefan Spangenberg](https://github.com/sspangenberg), [Lukas Laskowski](https://github.com/lasklu) and [Niklas Schilli](https://github.com/Mrnikbobjeff). Feel free to add your names to the list! + +Group 13 of the 2020 SWT I module included [Rohan Sawahn](https://github.com/rohansaw), [Jonas Schmidt](https://github.com/schmidtjonas), [Frederik Wollny](https://github.com/Freddy200), [Stefan Spangenberg](https://github.com/sspangenberg), [Lukas Laskowski](https://github.com/lasklu) and [Niklas Schilli](https://github.com/Mrnikbobjeff). Feel free to add your names to the list.