Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dragonx943 committed Jan 6, 2025
1 parent c22e45a commit a2f4129
Show file tree
Hide file tree
Showing 4 changed files with 107 additions and 9 deletions.
Binary file added .github/assets/vtuber.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions .github/workflows/backup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,3 +80,36 @@ jobs:
${{ steps.changelog.outputs.content }}
files: ${{ env.SIGNED_APK }}
prerelease: false

update:
needs: build
runs-on: ubuntu-22.04
permissions:
contents: write
steps:
- uses: actions/checkout@v3
with:
ref: nightly
fetch-depth: 0

- name: Update Build Number 📆
run: |
VERSION_NUMBER="${{ needs.build.outputs.new_tag }}"
COUNTER_LINKS=""
for (( i=0; i<${#VERSION_NUMBER}; i++ )); do
DIGIT="${VERSION_NUMBER:$i:1}"
COUNTER_LINKS+="[![Download](https://rule34.xxx/counter/$DIGIT.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) "
done
sed -i "/### <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/> Download <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/>/,/div>/c\### <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/> Download <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/>\n\n${COUNTER_LINKS}\n\n<div align=\"left\">\n\n* Nightly build can be downloaded from the [GitHub Releases](https://github.com/KotatsuApp/Kotatsu-Nightly/releases). Application has a built-in self-updating feature.\n* If you want to download a stable Kotatsu release please refer to the [main Kotatsu repository](https://github.com/KotatsuApp/Kotatsu?tab=readme-ov-file#download).\n\n</div>" README.md
- name: Update Docs + Commit 🌏
run: |
git config --local user.email "[email protected]"
git config --local user.name "Koitharu"
if [[ -n $(git status -s) ]]; then
git add README.md
git commit -m "Bump build number to ${{ needs.build.outputs.new_tag }}"
git push origin nightly
else
echo "No changes to push!"
fi
34 changes: 34 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,3 +101,37 @@ jobs:
${{ steps.changelog.outputs.content }}
files: ${{ env.SIGNED_APK }}
prerelease: false

update:
needs: build
if: needs.check.outputs.should_build == 'true'
runs-on: ubuntu-22.04
permissions:
contents: write
steps:
- uses: actions/checkout@v3
with:
ref: nightly
fetch-depth: 0

- name: Update Build Number 📆
run: |
VERSION_NUMBER="${{ needs.build.outputs.new_tag }}"
COUNTER_LINKS=""
for (( i=0; i<${#VERSION_NUMBER}; i++ )); do
DIGIT="${VERSION_NUMBER:$i:1}"
COUNTER_LINKS+="[![Download](https://rule34.xxx/counter/$DIGIT.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) "
done
sed -i "/### <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/> Download <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/>/,/div>/c\### <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/> Download <img src=\".\/.github\/app_icon.png\" alt=\"Kotatsu Logo\" width=\"16\" style=\"vertical-align: bottom;\"\/>\n\n${COUNTER_LINKS}\n\n<div align=\"left\">\n\n* Nightly build can be downloaded from the [GitHub Releases](https://github.com/KotatsuApp/Kotatsu-Nightly/releases). Application has a built-in self-updating feature.\n* If you want to download a stable Kotatsu release please refer to the [main Kotatsu repository](https://github.com/KotatsuApp/Kotatsu?tab=readme-ov-file#download).\n\n</div>" README.md
- name: Update Docs + Commit 🌏
run: |
git config --local user.email "[email protected]"
git config --local user.name "Koitharu"
if [[ -n $(git status -s) ]]; then
git add README.md
git commit -m "Bump build number to ${{ needs.build.outputs.new_tag }}"
git push origin nightly
else
echo "No changes to push!"
fi
49 changes: 40 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,50 @@
# Kotatsu Nightly
<div align="center">

[Kotatsu](https://github.com/KotatsuApp/Kotatsu) is a free and open-source manga reader for Android with built-in online content sources. This repository contains a **nightly builds** with latest changes from the [`devel`](https://github.com/KotatsuApp/Kotatsu/commits/devel/) branch.
<a href="https://kotatsu.app">
<img src="./.github/assets/vtuber.png" alt="Kotatsu Logo" title="Kotatsu" width="600"/>
</a>

* Nightly builds can be installed alongside with [Kotatsu](https://github.com/KotatsuApp/Kotatsu) (has a different package id).
* Kotatsu Nightly is likely a Alpha / Beta version of [Kotatsu](https://github.com/KotatsuApp/Kotatsu) so it can be **unstable** / more Bugs *OR* better than [Kotatsu](https://github.com/KotatsuApp/Kotatsu).
* A new nightly build will be built and published automatically about `00:50 UTC`.
# [Kotatsu Nightly](#)

### Download
**[Kotatsu](https://github.com/KotatsuApp/Kotatsu) is a free and open-source manga reader for Android with built-in online content sources. This repository contains a nightly builds with latest changes from the [devel](https://github.com/KotatsuApp/Kotatsu/commits/devel/) branch.**

Nightly build can be downloaded from the **[GitHub Releases](https://github.com/KotatsuApp/Kotatsu-Nightly/releases)**. Application has a built-in self-updating feature.
[![Sources count](https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2FKotatsuApp%2Fkotatsu-parsers%2Frefs%2Fheads%2Fmaster%2F.github%2Fsummary.yaml&query=total&label=manga%20sources&color=%23E9321C)](https://github.com/KotatsuApp/kotatsu-parsers) ![Android 5.0](https://img.shields.io/badge/android-5.0+-brightgreen) [![weblate](https://hosted.weblate.org/widgets/kotatsu/-/strings/svg-badge.svg)](https://hosted.weblate.org/engage/kotatsu/) [![Telegram](https://img.shields.io/badge/chat-telegram-60ACFF)](https://t.me/kotatsuapp) [![Discord](https://img.shields.io/discord/898363402467045416?color=5865f2&label=discord)](https://discord.gg/NNJ5RgVBC5) [![License](https://img.shields.io/github/license/KotatsuApp/Kotatsu)](https://github.com/KotatsuApp/Kotatsu/blob/devel/LICENSE)

If you want to download a **stable** Kotatsu release please refer to the [main Kotatsu repository](https://github.com/KotatsuApp/Kotatsu?tab=readme-ov-file#download).
### <img src="./.github/app_icon.png" alt="Kotatsu Logo" width="16" style="vertical-align: bottom;"/> Download <img src="./.github/app_icon.png" alt="Kotatsu Logo" width="16" style="vertical-align: bottom;"/>

--------
[![Download](https://rule34.xxx/counter/2.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) [![Download](https://rule34.xxx/counter/0.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) [![Download](https://rule34.xxx/counter/2.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) [![Download](https://rule34.xxx/counter/5.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) [![Download](https://rule34.xxx/counter/0.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) [![Download](https://rule34.xxx/counter/1.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) [![Download](https://rule34.xxx/counter/0.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest) [![Download](https://rule34.xxx/counter/5.gif)](https://github.com/KotatsuApp/kotatsu-nightly/releases/latest)

<div align="left">

* Nightly build can be downloaded from the [GitHub Releases](https://github.com/KotatsuApp/Kotatsu-Nightly/releases). Application has a built-in self-updating feature.
* If you want to download a stable Kotatsu release please refer to the [main Kotatsu repository](https://github.com/KotatsuApp/Kotatsu?tab=readme-ov-file#download).

</div>

### <img src="./.github/app_icon.png" alt="Kotatsu Logo" width="16" style="vertical-align: bottom;"/> Notes <img src="./.github/app_icon.png" alt="Kotatsu Logo" width="16" style="vertical-align: bottom;"/>

<div align="left">

* Nightly builds can be installed alongside with [Kotatsu](https://github.com/KotatsuApp/Kotatsu) (has a different package id)
* Kotatsu Nightly is likely a Alpha / Beta version of [Kotatsu](https://github.com/KotatsuApp/Kotatsu) so it can be unstable / more Bugs OR better than [Kotatsu](https://github.com/KotatsuApp/Kotatsu)
* A new nightly build will be built and published automatically about `00:50 UTC`

</div>

### License

[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)

<div align="left">

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.

</div>

### DMCA disclaimer

<div align="left">

The developers of this application do not have any affiliation with the content available in the app. It collects content from sources that are freely available through any web browser.

</div>

0 comments on commit a2f4129

Please sign in to comment.