docs update

Author: xmdnx

README.md

@@ -1,21 +1,29 @@
-# rabbitGram Desktop – Telegram Desktop based messenger with special features
+<div align="center">
 
-[![Windows.](https://github.com/rabbitgramdesktop/rabbitgramdesktop/actions/workflows/win.yml/badge.svg)](https://github.com/rabbitgramdesktop/rabbitgramdesktop/actions/workflows/win.yml)
+<img src="docs/assets/logo.png" alt="rabbitGram logo" width="200"/>
+
+# rabbitGram Desktop
+### Telegram Desktop based messenger with special features
 
 This is the complete source code and the build instructions for the app based on the official [Telegram][telegram] messenger desktop client.
 
-![image](https://github.com/xmdnx/exteraGramDesktop/assets/72883689/082fe7d6-eeba-4198-83ab-843d08ac909c)
+<img src="docs/assets/screenshot_channel.png" alt="Screenshot"/>
 
 The source code is published under GPLv3 with OpenSSL exception, the license is available [here][license].
 
+</div>
+
 ## Features
 
-* Sticker size setting
-* Userpic corner radius
+* Hide phone number in profile
 * Auto-hiding notifications
+* Custom app icon
+* Userpic corner radius
 * Side menu editor
-* Hide phone number in profile
-* Show user ID in profile
+* Sticker size setting
+* Seconds in time
+* Sender's avatar in groups
+* Comma after mention
 
 ## Supported systems
 
@@ -60,6 +68,7 @@ You can build rabbitGram Desktop yourself using [build instructions][build_instr
 ## Special thanks to
 
 * [Kotatogram][kotatogram]
+* [Materialgram][materialgram]
 * [64Gram][64gram]
 
 [//]: # (LINKS)
@@ -72,4 +81,5 @@ You can build rabbitGram Desktop yourself using [build instructions][build_instr
 [macos]: docs/building-mac.md
 [build_instructions]: https://github.com/rabbitGramDesktop/rabbitGramDesktop#build-instructions
 [kotatogram]: https://github.com/kotatogram/kotatogram-desktop
+[materialgram]: https://github.com/kukuruzka165/materialgram
 [64gram]: https://github.com/TDesktop-x64/tdesktop

prepare_version.py bundle_release.py

@@ -1,4 +1,3 @@
-# new version preparation script
 # libraries
 import os, shutil
 from datetime import date
@@ -18,17 +17,17 @@
 
 # functions
 def log(text, level):
-    print("#" + " " * level + text)
+    print(f"#{" " * level}{text}")
 
 def set_repo_path():
     log("Setting repo path...", 1)
     config["repo_path"] = os.getcwd()
     log("Repo path was not set in config", 2)
-    log("Set repo path to: " + config["repo_path"], 2)
+    log(f"Set repo path to: {config["repo_path"]}", 2)
 
 def set_version():
     log("Setting version...", 1)
-    with open(config["repo_path"] + "/Telegram/SourceFiles/core/version.h", "r") as version_file:
+    with open(f"{config["repo_path"]}/Telegram/SourceFiles/core/version.h", "r") as version_file:
         version_code = version_file.readlines()[25]
         config["version"] += version_code.replace('constexpr auto AppVersionStr = "', '').replace('";', date.today().strftime("-%d%m%Y")).replace('\n', '')
         config["tgversion"] += version_code.replace('constexpr auto AppVersionStr = "', '').replace('";', '').replace('\n', '')
@@ -38,12 +37,12 @@ def set_version():
 
 def set_iss():
     log("Updating iss file...", 1)
-    iss_file = open(config["repo_path"] + "/Telegram/build/setup.iss", "r", encoding="utf-8")
+    iss_file = open(f"{config["repo_path"]}/Telegram/build/setup.iss", "r", encoding="utf-8")
     iss_file_data = iss_file.readlines()
-    iss_file_data[3] = '#define MyAppVersion "' + config["tgversion"] + '"\n'
-    iss_file_data[10] = '#define MyAppVersionFull "' + config["version"] + '"\n'
+    iss_file_data[3] = f'#define MyAppVersion "{config["tgversion"]}"\n'
+    iss_file_data[10] = f'#define MyAppVersionFull "{config["version"]}"\n'
     iss_file.close()
-    iss_file = open(config["repo_path"] + "/Telegram/build/setup.iss", "w", encoding="utf-8")
+    iss_file = open(f"{config["repo_path"]}/Telegram/build/setup.iss", "w", encoding="utf-8")
     iss_file.writelines(iss_file_data)
 
 def check_files():
@@ -61,21 +60,21 @@ def make_portable():
     log("Making portable version", 1)
     log("Creating 'portable' folder", 2)
     try:
-        os.mkdir(os.path.join(config["repo_path"] + "/out/Release/portable"))
+        os.mkdir(os.path.join(f"{config["repo_path"]}/out/Release/portable"))
         log("Created 'portable' folder", 3)
     except:
         log("Folder 'portable' already exists", 3)
     log("Copying portable files", 2)
     try:
-        shutil.copyfile(os.path.join(config["repo_path"] + "/out/Release/", config["exe_filename"]), os.path.join(config["repo_path"] + "/out/Release/portable", config["exe_filename"]))
+        shutil.copyfile(f"{config["repo_path"]}/out/Release/{config["exe_filename"]}", f"{config["repo_path"]}/out/Release/portable/{config["exe_filename"]}")
         if config["ota_enabled"]:
-            shutil.copyfile(os.path.join(config["repo_path"] + "/out/Release/", "Updater.exe"), os.path.join(config["repo_path"] + "/out/Release/portable", "Updater.exe"))
-        shutil.copytree(config["repo_path"] + "/out/Release/modules", config["repo_path"] + "/out/Release/portable/modules")
+            shutil.copyfile(f"{config["repo_path"]}/out/Release/Updater.exe", f"{config["repo_path"]}/out/Release/portable/Updater.exe")
+        shutil.copytree(f"{config["repo_path"]}/out/Release/modules", f"{config["repo_path"]}/out/Release/portable/modules")
         log("Files copied to 'portable' folder", 3)
     except:
         log("Files already exist", 3)
     log("Making archive...", 2)
-    shutil.make_archive(os.path.join(f"{config["repo_path"]}/out/Release/releases/rtgdrelease-{config["version"]}/rtgdportable-x64.{config["version"]}"), 'zip', os.path.join(f"{config["repo_path"]}/out/Release/portable"))
+    shutil.make_archive(f"{config["repo_path"]}/out/Release/releases/rtgdrelease-{config["version"]}/rtgdportable-x64.{config["version"]}", 'zip', f"{config["repo_path"]}/out/Release/portable")
 
 def make_ota_package():
     log("Making OTA package", 1)
@@ -84,7 +83,7 @@ def make_ota_package():
     cmd = f"Packer.exe -path {config['exe_filename']} -version {config['intversion']} -target win64"
     os.system(cmd)
     os.chdir(first_loc)
-    shutil.copyfile(os.path.join(f"{config["repo_path"]}/out/Release/tx64upd{config["intversion"]}"), os.path.join(f"{config["repo_path"]}/out/Release/releases/rtgdrelease-{config["version"]}/tx64upd{config["intversion"]}"))
+    shutil.copyfile(f"{config["repo_path"]}/out/Release/tx64upd{config["intversion"]}", f"{config["repo_path"]}/out/Release/releases/rtgdrelease-{config["version"]}/tx64upd{config["intversion"]}")
 
 if config["repo_path"] == "":
     set_repo_path()

docs/assets/logo.png

@@ -17,15 +17,15 @@ Go to ***BuildPath*** and run
 
     sudo xcode-select -s /Applications/Xcode.app/Contents/Developer
 
-    git clone --recursive https://github.com/rabbitGramDesktop/rabbitGramDesktop.git
-    ./rabbitGramDesktop/Telegram/build/prepare/mac.sh
+    git clone --recursive https://github.com/rabbitgramdesktop/rabbitgramdesktop.git
+    ./rabbitgramdesktop/Telegram/build/prepare/mac.sh
 
 ### Building the project
 
-Go to ***BuildPath*/rabbitGramDesktop/Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
+Go to ***BuildPath*/rabbitgramdesktop/Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
 
     ./configure.sh -D TDESKTOP_API_ID=YOUR_API_ID -D TDESKTOP_API_HASH=YOUR_API_HASH
 
-Then launch Xcode, open ***BuildPath*/rabbitGramDesktop/out/Telegram.xcodeproj** and build for Debug / Release.
+Then launch Xcode, open ***BuildPath*/rabbitgramdesktop/out/Telegram.xcodeproj** and build for Debug / Release.
 
 [api_credentials]: api_credentials.md

docs/assets/screenshot_about.png

@@ -12,7 +12,7 @@ The build is done in **Visual Studio 2022** with **10.0.22000.0** SDK version.
 
 Choose an empty folder for the future build, for example **D:\\TBuild**. It will be named ***BuildPath*** in the rest of this document. Create two folders there, ***BuildPath*\\ThirdParty** and ***BuildPath*\\Libraries**.
 
-All commands (if not stated otherwise) will be launched from **x64 Native Tools Command Prompt for VS 2022.bat** (should be in **Start Menu > Visual Studio 2022** menu folder). Pay attention not to use any other Command Prompt.
+All commands (if not stated otherwise) will be launched from **x64 Native Tools Command Prompt for VS 2022** (should be in **Start Menu > Visual Studio 2022** menu folder). Pay attention not to use any other Command Prompt.
 
 ### Obtain your API credentials
 
@@ -26,20 +26,20 @@ You will require **api_id** and **api_hash** to access the Telegram API servers.
 
 ## Clone source code and prepare libraries
 
-Open **x64 Native Tools Command Prompt for VS 2022.bat**, go to ***BuildPath*** and run
+Open **x64 Native Tools Command Prompt for VS 2022**, go to ***BuildPath*** and run
 
-    git clone --recursive https://github.com/rabbitGramDesktop.git
-    rabbitGramDesktop\Telegram\build\prepare\win.bat
+    git clone --recursive https://github.com/rabbitgramdesktop/rabbitgramdesktop.git
+    rabbitgramdesktop\Telegram\build\prepare\win.bat
 
 ## Build the project
 
-Go to ***BuildPath*\\rabbitGramDesktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
+Go to ***BuildPath*\\rabbitgramdesktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
 
     configure.bat x64 -D TDESKTOP_API_ID=YOUR_API_ID -D TDESKTOP_API_HASH=YOUR_API_HASH
 
-* Open ***BuildPath*\\rabbitGramDesktop\\out\\Telegram.sln** in Visual Studio 2022
+* Open ***BuildPath*\\rabbitgramdesktop\\out\\Telegram.sln** in Visual Studio 2022
 * Select Telegram project and press Build > Build Telegram (Debug and Release configurations)
-* The result Telegram.exe will be located in ***BuildPath*\rabbitGramDesktop\out\Debug** (and **Release**)
+* The result rabbitGram.exe will be located in ***BuildPath*\rabbitgramdesktop\out\Debug** (and **Release**)
 
 ### Qt Visual Studio Tools
 

docs/assets/screenshot_channel.png

@@ -12,7 +12,7 @@ The build is done in **Visual Studio 2022** with **10.0.22000.0** SDK version.
 
 Choose an empty folder for the future build, for example **D:\\TBuild**. It will be named ***BuildPath*** in the rest of this document. Create two folders there, ***BuildPath*\\ThirdParty** and ***BuildPath*\\Libraries**.
 
-All commands (if not stated otherwise) will be launched from **x86 Native Tools Command Prompt for VS 2022.bat** (should be in **Start Menu > Visual Studio 2022** menu folder). Pay attention not to use any other Command Prompt.
+All commands (if not stated otherwise) will be launched from **x86 Native Tools Command Prompt for VS 2022** (should be in **Start Menu > Visual Studio 2022** menu folder). Pay attention not to use any other Command Prompt.
 
 ### Obtain your API credentials
 
@@ -26,20 +26,20 @@ You will require **api_id** and **api_hash** to access the Telegram API servers.
 
 ## Clone source code and prepare libraries
 
-Open **x86 Native Tools Command Prompt for VS 2022.bat**, go to ***BuildPath*** and run
+Open **x86 Native Tools Command Prompt for VS 2022**, go to ***BuildPath*** and run
 
-    git clone --recursive https://github.com/rabbitGramDesktop.git
-    rabbitGramDesktop\Telegram\build\prepare\win.bat
+    git clone --recursive https://github.com/rabbitgramdesktop.git
+    rabbitgramdesktop\Telegram\build\prepare\win.bat
 
 ## Build the project
 
-Go to ***BuildPath*\\rabbitGramDesktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
+Go to ***BuildPath*\\rabbitgramdesktop\\Telegram** and run (using [your **api_id** and **api_hash**](#obtain-your-api-credentials))
 
     configure.bat -D TDESKTOP_API_ID=YOUR_API_ID -D TDESKTOP_API_HASH=YOUR_API_HASH
 
-* Open ***BuildPath*\\rabbitGramDesktop\\out\\Telegram.sln** in Visual Studio 2022
+* Open ***BuildPath*\\rabbitgramdesktop\\out\\Telegram.sln** in Visual Studio 2022
 * Select Telegram project and press Build > Build Telegram (Debug and Release configurations)
-* The result Telegram.exe will be located in ***BuildPath*\rabbitGramDesktop\out\Debug** (and **Release**)
+* The result rabbitGram.exe will be located in ***BuildPath*\rabbitgramdesktop\out\Debug** (and **Release**)
 
 ### Qt Visual Studio Tools
 

docs/assets/screenshot_settings.png

@@ -0,0 +1,23 @@
+# Release bundle build instructions for Windows 64-bit
+
+- [Prepare script](#prepare-script)
+- [Install Inno Setup](#install-inno-setup)
+- [Clone source code and prepare libraries](#clone-source-code-and-prepare-libraries)
+- [Build the project](#build-the-project)
+- [Qt Visual Studio Tools](#qt-visual-studio-tools)
+
+## Prepare script
+
+Open **bundle_release.py** in preferred code editor and change needed variables in **config** dict.
+
+## Install Inno Setup
+
+Download [Inno Setup][inno-setup], install it, then go to installation path, copy it, add to PATH, reboot, and viola!
+
+## Bundle release
+
+Run **bundle_release.py**. You will find result files in:
+
+**rabbitgramdesktop/out/Release/releases/rtgdrelease-X.XX.X-XXXXXXXX**
+
+[inno-setup]: https://jrsoftware.org/isdl.php