feat: update README.md

feat: add note
This commit is contained in:
ZavaruKitsu 2024-01-02 04:15:13 +03:00
parent 74abaccab3
commit 2f069bcd02
9 changed files with 27 additions and 46 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 22 KiB

BIN
.github/demos/demo4.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.2 KiB

View file

@ -9,11 +9,17 @@
- Anti-recall
- Font customization
- Streamer mode
- Material Design switches
- Local Telegram Premium
- Sync read states and message history with AyuSync *(TBA)*
- Enhanced appearance
<img src='.github/demos/demo1.png' width='250'> <img src='.github/demos/demo2.png' width='250'> <img src='.github/demos/demo3.png' width='250'>
And many more. Check out our [Documentation](https://docs.ayugram.one/desktop/).
## Preferences screenshots
<img src='.github/demos/demo1.png' width='268'>
<img src='.github/demos/demo2.png' width='268'>
<img src='.github/demos/demo3.png' width='268'>
<img src='.github/demos/demo4.png' width='268'>
## Downloads
@ -27,12 +33,7 @@ build by yourself.
### Arch Linux
It is recommended to build AyuGram from source on any Linux distro.
But if you're brave enough, you can install `ayugram-desktop-git` or `ayugram-desktop-bin`
from [AUR](https://aur.archlinux.org/packages?O=0&K=ayugram).
These packages maintained by [westpain](https://github.com/incycledream). *We're not responsible for them.*
You can install `ayugram-desktop` or `ayugram-desktop-git` from [AUR](https://aur.archlinux.org/packages?O=0&K=ayugram).
### Any other Linux distro
@ -48,23 +49,27 @@ Make sure you have these components installed with VS Build Tools:
## Donation
If you enjoy using **AyuGram** and want to send us a tip, here's how you can do it:
Enjoy using **AyuGram**? Consider sending us a tip!
- Using [Boosty](https://boosty.to/alexeyzavar) - any card and PayPal
- Using cryptocurrency - `TRpbajq38qU8joThgAfKJLyEPbNjzsdPJ1` (Tron + USDT)
[Here's available methods.](https://docs.ayugram.one/donate/)
## Credits
### Telegram clients
- [Telegram Desktop](https://github.com/telegramdesktop/tdesktop)
- [Kotatogram](https://github.com/kotatogram/kotatogram-desktop)
- [64Gram](https://github.com/TDesktop-x64/tdesktop)
- [Forkgram](https://github.com/forkgram/tdesktop)
- [SQLite](https://github.com/sqlite/sqlite)
- [sqlite_orm](https://github.com/fnc12/sqlite_orm)
### Very special thanks to
### Libraries used
- [Solar Icon Set](https://solariconset.com/)
- [JSON for Modern C++](https://github.com/nlohmann/json)
- [BitConverter](https://github.com/YanjieHe/BitConverter)
- [Not Enough Standards](https://github.com/Alairion/not-enough-standards)
- [SQLite](https://github.com/sqlite/sqlite)
- [sqlite_orm](https://github.com/fnc12/sqlite_orm)
### Icons
- [Solar Icon Set](https://www.figma.com/community/file/1166831539721848736)

View file

@ -1,13 +1,7 @@
## Obtaining your API credentials
## API credentials
To build your version of Telegram Desktop you're required to provide your own **api_id** and **api_hash** for the Telegram API access.
Official Telegram keys:
How to obtain your **api_id** and **api_hash** is described here: [https://core.telegram.org/api/obtaining_api_id](https://core.telegram.org/api/obtaining_api_id)
If you're building the application not for deployment, but only for test purposes you can use TEST ONLY credentials, which are very limited by the Telegram API server:
**api_id**: 17349
**api_hash**: 344583e45741c457fe1862106095a5eb
Your users will start getting internal server errors on login if you deploy an app using those **api_id** and **api_hash**.
API_ID `2040`
API_HASH `b18441a1ff607e10a989891a5462e627`

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1 MiB

View file

@ -4,7 +4,6 @@
- [Install third party software](#install-third-party-software)
- [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 folder
@ -27,6 +26,8 @@ Open **x64 Native Tools Command Prompt for VS 2022.bat**, go to ***BuildPath***
git clone --recursive https://github.com/AyuGram/AyuGramDesktop.git tdesktop
tdesktop\Telegram\build\prepare\win.bat
You may encounter an error saying that your IP is not allowed - simply turn on VPN.
## Build the project
Go to ***BuildPath*\\tdesktop\\Telegram** and run
@ -36,12 +37,3 @@ Go to ***BuildPath*\\tdesktop\\Telegram** and run
* Open ***BuildPath*\\tdesktop\\out\\Telegram.sln** in Visual Studio 2022
* Select Telegram project and press Build > Build Telegram (Debug and Release configurations)
* The result AyuGram.exe will be located in **D:\TBuild\tdesktop\out\Debug** (and **Release**)
### Qt Visual Studio Tools
For better debugging you may want to install Qt Visual Studio Tools:
* Open **Extensions** -> **Manage Extensions**
* Go to **Online** tab
* Search for **Qt**
* Install **Qt Visual Studio Tools** extension

View file

@ -1,10 +0,0 @@
macOS:
breakpad - clone breakpad like for msvc, including the patch, open breakpad/src/client/mac/Breakpad.xcodeproj and build Release
dump_syms - open breakpad/src/tools/mac/dump_syms/dump_syms.xcodeproj and build Release, copy dump_syms from ~/Library/Developer/Xcode/DerivedData/dump_syms-[a-z0-9]+/Build/Products/Release/ to BuildPath/Libraries/breakpad/src/tools/mac/dump_syms/build/Release/
minidump_stackwalk - go to Libraries/breakpad, run "configure", run "make"
Windows:
install InnoSetup
open brekpad/src/tools/windows/dump_syms/dump_syms.vcproj, upgrade, change SDK and build Debug and Release