Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DamianMorozov committed Dec 8, 2024
1 parent 96c18be commit 5b7b6bb
Show file tree
Hide file tree
Showing 20 changed files with 40 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Clients/TgDownloaderDesktop/Package.appxmanifest
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<Identity
Name="d0c48b6b-afe7-46b5-a630-2afcd7e2e083"
Publisher="CN=TgDownloader"
Version="0.5.240.0" />
Version="0.5.250.0" />

<mp:PhoneIdentity PhoneProductId="d0c48b6b-afe7-46b5-a630-2afcd7e2e083" PhonePublisherId="00000000-0000-0000-0000-000000000000"/>

Expand Down
Binary file removed Docs/Assets/TgDownloaderConsole.png
Binary file not shown.
Binary file added Docs/Assets/TgDownloaderConsoleAdvanced.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Assets/TgDownloaderConsoleHome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Docs/Assets/TgDownloaderDesktopConnection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Docs/Assets/TgDownloaderDesktopHome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified Docs/Assets/TgDownloaderDesktopSettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Assets/TgDownloaderDesktopSources.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Assets/v0.5.250/TgDownloaderConsoleHome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Docs/Assets/v0.5.250/TgDownloaderDesktopHome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion Docs/CHANGELOG-RUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@
Формат основан на [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
и этот проект придерживается [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.5.240] - 2024-12-03
## [0.5.250] - 2024-12-08
### Изменено
- Обновлена страница настроек для TgDownloaderDesktop
### Добавлено
- Добавлена таблица контактов в хранилище
- Добавлена таблица сторис в хранилище
- Добавлен поиск и просмотр контактов для TgDownloaderConsole
- Добавлен поиск и просмотр сторис для TgDownloaderConsole
- Добавлена страница источников для TgDownloaderDesktop
- Добавлен скрипт PowerShell установки TgDownloaderDesktop

## [0.5.230] - 2024-12-01
### Исправлено
Expand Down
7 changes: 6 additions & 1 deletion Docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.5.240] - 2024-12-03
## [0.5.250] - 2024-12-08
### Changed
- Updated settings page for TgDownloaderDesktop
### Added
- Added contact table to storage
- Added stories table to storage
- Added searching and viewing of contacts for TgDownloaderConsole
- Added searching and viewing of stories for TgDownloaderConsole
- Added sources page for TgDownloaderDesktop
- Added PowerShell script for installing TgDownloaderDesktop

## [0.5.230] - 2024-12-01
### Fixed
Expand Down
9 changes: 6 additions & 3 deletions Docs/GUIDES-RUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,15 @@
- [Руководство по настройке десктоп версии](GUIDE-SETUP-DESKTOP-RUS.md)
- [Руководство по настройке докер версии](GUIDE-SETUP-DOCKER-RUS.md)

## Запуск под ОС Windows
## Запуск TgDownloaderDesktop под ОС Windows
- Запустите файл `TgDownloaderDesktop-Installing.ps1` в PowerShell.

## Запуск TgDownloaderConsole под ОС Windows
- Распакуйте архив `TgDownloader v1.2.333.zip` в каталог `TgDownloader v1.2.333`.
- Измените текущий каталог `cd TgDownloader v1.2.333`.
- Выполните команду `TgDownloaderConsole.exe`

## Запуск под ОС Linux
## Запуск TgDownloaderConsole под ОС Linux
- Распакуйте архив `TgDownloader v1.2.333.zip` в `TgDownloader v1.2.333`.
- Измените текущий каталог `cd TgDownloader v1.2.333`.
- Выполните команду `dotnet TgDownloaderConsole.dll`
Expand All @@ -18,7 +21,7 @@
- Настройте Telegram клиент
- Настройте скачивание

## Настройки по умолчанию
## Настройки по умолчанию для TgDownloaderConsole
- Удалите файл `TgDownloader.xml`.

# Руководство для загрузки групп
Expand Down
11 changes: 7 additions & 4 deletions Docs/GUIDES.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
## Guides
## Guides
- [Guide to setup the desktop version](GUIDE-SETUP-DESKTOP.md)
- [Guide to setup the docker version](GUIDE-SETUP-DOCKER.md)

## Run under Windows OS
## Запуск TgDownloaderDesktop под ОС Windows
- Run the `TgDownloaderDesktop-Installing.ps1` file in PowerShell.

## Run TgDownloaderConsole under Windows OS
- Extract the `TgDownloader v1.2.333.zip` archive to `TgDownloader v1.2.333` directory
- Change the current directory to `cd TgDownloader v1.2.333`
- Run the `TgDownloaderConsole.exe` command or double click the file

## Run under Linux OS
## Run TgDownloaderConsole under Linux OS
- Extract the `TgDownloader v1.2.333.zip` archive to `TgDownloader v1.2.333` directory
- Change the current directory to `cd TgDownloader v1.2.333`
- Run the `dotnet TgDownloaderConsole.dll` command
Expand All @@ -18,7 +21,7 @@
- Set up the Telegram client
- Set up a download

## Default settings
## Default settings for TgDownloaderConsole
- Delete the file `TgDownloader.xml`

# Guide for downloading groups
Expand Down
1 change: 1 addition & 0 deletions Docs/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
## <div align="center"><b><a href="../README-RUS.md">Прочти меня</a> | <a href="../CHANGELOG-RUS.md">История версий</a> | <a href="RELEASE.md">Релизы</a> | <a href="SCREENSHOTS.md">Скриншоты</a> | <a href="GUIDES-RUS.md">Руководства</a></b></div>

- GitHub all releases ![GitHub all releases](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/total?style=social)
- GitHub release v0.5.250 ![GitHub release v0.5.250](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.250/total?style=social)
- GitHub release v0.5.230 ![GitHub release v0.5.230](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.230/total?style=social)
- GitHub release v0.5.180 ![GitHub release v0.5.180](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.180/total?style=social)
- GitHub release v0.5.160 ![GitHub release v0.5.160](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.160/total?style=social)
Expand Down
14 changes: 13 additions & 1 deletion Docs/SCREENSHOTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,25 @@

## Actual screenshots TgDownloaderConsole

<p align="center"><img src="Assets/TgDownloaderConsole.png"></p>
<p align="center"><img src="Assets/TgDownloaderConsoleHome.png"></p>
<p align="center"><img src="Assets/TgDownloaderConsoleAdvanced.png"></p>

## Actual screenshots TgDownloaderDesktop

<p align="center"><img src="Assets/TgDownloaderDesktopHome.png"></p>
<p align="center"><img src="Assets/TgDownloaderDesktopSettings.png"></p>
<p align="center"><img src="Assets/TgDownloaderDesktopConnection.png"></p>
<p align="center"><img src="Assets/TgDownloaderDesktopSources.png"></p>

## [0.5.250] - 2024-12-08
### TgDownloaderConsole
<p align="center"><img src="Assets/v0.5.250/TgDownloaderConsoleHome.png"></p>
<p align="center"><img src="Assets/v0.5.250/TgDownloaderConsoleAdvanced.png"></p>
### TgDownloaderDesktop
<p align="center"><img src="Assets/v0.5.250/TgDownloaderDesktopHome.png"></p>
<p align="center"><img src="Assets/v0.5.250/TgDownloaderDesktopSettings.png"></p>
<p align="center"><img src="Assets/v0.5.250/TgDownloaderDesktopConnection.png"></p>
<p align="center"><img src="Assets/v0.5.250/TgDownloaderDesktopSources.png"></p>

## [0.5.230] - 2024-12-01
### TgDownloaderConsole
Expand Down

0 comments on commit 5b7b6bb

Please sign in to comment.