Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DamianMorozov committed Dec 2, 2024
1 parent ae372b3 commit b1aaeae
Show file tree
Hide file tree
Showing 6 changed files with 76 additions and 11 deletions.
58 changes: 58 additions & 0 deletions Clients/TgDownloaderDesktop/TgDownloaderDesktop.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,62 @@
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</PRIResource>
</ItemGroup>

<ItemGroup>
<Folder Include="Docs\" />
</ItemGroup>

<ItemGroup>
<None Include="..\..\Docs\CHANGELOG-RUS.md" Link="Docs\CHANGELOG-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\CHANGELOG.md" Link="Docs\CHANGELOG.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\GUIDE-SETUP-DESKTOP-RUS.md" Link="Docs\GUIDE-SETUP-DESKTOP-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\GUIDE-SETUP-DESKTOP.md" Link="Docs\GUIDE-SETUP-DESKTOP.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\GUIDE-SETUP-DOCKER-RUS.md" Link="Docs\GUIDE-SETUP-DOCKER-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\GUIDE-SETUP-DOCKER.md" Link="Docs\GUIDE-SETUP-DOCKER.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\GUIDES-RUS.md" Link="Docs\GUIDES-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\GUIDES.md" Link="Docs\GUIDES.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\ISSUE-RUS.md" Link="Docs\ISSUE-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\ISSUE.md" Link="Docs\ISSUE.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\RELEASE.md" Link="Docs\RELEASE.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\RESOURCES-RUS.md" Link="Docs\RESOURCES-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\RESOURCES.md" Link="Docs\RESOURCES.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\Docs\SCREENSHOTS.md" Link="Docs\SCREENSHOTS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\LICENSE.md" Link="Docs\LICENSE.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\README-RUS.md" Link="Docs\README-RUS.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
<None Include="..\..\README.md" Link="Docs\README.md">
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
</None>
</ItemGroup>
</Project>
4 changes: 4 additions & 0 deletions Docs/CHANGELOG-RUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
Формат основан на [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
### Изменено
- Обновлена страница настроек для TgDownloaderDesktop

## [0.5.230] - 2024-12-01
### Исправлено
- Исправлено отображение спец символов в имени каталога для скачивания для TgDownloaderConsole
Expand Down
4 changes: 4 additions & 0 deletions Docs/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ 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
### Changed
- Updated settings page for TgDownloaderDesktop

## [0.5.230] - 2024-12-01
### Fixed
- Fixed display of special characters in download directory name for TgDownloaderConsole
Expand Down
1 change: 0 additions & 1 deletion Docs/RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@

- GitHub all releases ![GitHub all releases](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/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.200 ![GitHub release v0.5.200](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.5.200/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)
- GitHub release v0.4.150 ![GitHub release v0.4.150](https://img.shields.io/github/downloads/DamianMorozov/TgDownloader/v0.4.150/total?style=social)
Expand Down
10 changes: 5 additions & 5 deletions README-RUS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@
![GitHub issues](https://img.shields.io/github/issues/DamianMorozov/TgDownloader?style=social)
![GitHub license](https://img.shields.io/github/license/DamianMorozov/TgDownloader?style=social)

## Описание продукта
Скачайте файлы каналов или групп Telegram, в которых вы состоите.
## Назначение продукта
Упорядоченное скачивание файлов из ТГ каналов/групп/чатов (к которым есть доступ под своим аккаунтом). Файлы из каждого источника можно скачивать в отдельный каталог. Можно указать какие источники включить в авто-скачивание. Есть многопоточный режим скачивания. Консольная версия практически завершена (продакшн). Десктоп версии находится в активной стадии разработки (превью).

## Требования к установке
- [Скачать .NET 8.0](https://dotnet.microsoft.com/ru-ru/download/dotnet/8.0)
- [Скачать .NET 9.0](https://dotnet.microsoft.com/ru-ru/download/dotnet/9.0)
- [Зарегистрируйте Telegram приложение](https://my.telegram.org/apps/)
- Сохраните значения полей "App api_id" и "App api_hash"

## Статус
![Alt](https://repobeats.axiom.co/api/embed/c14de41002f34b22bb5ad579995904aa375930d2.svg "Repobeats analytics image")

## Поддержка продукта
Пожалуйста, нажмите на кнопку `звездочка`, если эта программа была вам полезна.

Expand All @@ -34,3 +31,6 @@

## Docker образы
- [TgDownloader-Console Докер образ](https://hub.docker.com/repository/docker/damianmorozov/tgdownloader-console/)

## Статус
![Alt](https://repobeats.axiom.co/api/embed/c14de41002f34b22bb5ad579995904aa375930d2.svg "Repobeats analytics image")
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@
![GitHub issues](https://img.shields.io/github/issues/DamianMorozov/TgDownloader?style=social)
![GitHub license](https://img.shields.io/github/license/DamianMorozov/TgDownloader?style=social)

## Product description
Download files of the Telegram channels or groups you are a member of.
## Product assignment
Organized downloading of files from TG channels/groups/chats (accessed under your account). Files from each source can be downloaded to a separate directory. You can specify which sources to include in auto-downloading. There is a multithreaded download mode. Console version is almost completed (production). The desktop version is in active development stage (preview).

## Install Requirements
- [Download .NET 8.0](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
- [Download .NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
- [Register Telegram app](https://my.telegram.org/apps/)
- Save the values of the "App api_id" and "App api_hash" fields

## Status
![Alt](https://repobeats.axiom.co/api/embed/c14de41002f34b22bb5ad579995904aa375930d2.svg "Repobeats analytics image")

## Product support
Please click the `star` button if this tool was helpful to you.

Expand All @@ -34,3 +31,6 @@ Please click the `star` button if this tool was helpful to you.

## Docker images
- [TgDownloader-Console Docker image](https://hub.docker.com/repository/docker/damianmorozov/tgdownloader-console/)

## Status
![Alt](https://repobeats.axiom.co/api/embed/c14de41002f34b22bb5ad579995904aa375930d2.svg "Repobeats analytics image")

0 comments on commit b1aaeae

Please sign in to comment.