Skip to content
This repository has been archived by the owner on Oct 6, 2024. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
matsumo0922 committed Dec 15, 2023
1 parent 2cdeda2 commit 9f62ce6
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 17 deletions.
15 changes: 3 additions & 12 deletions .github/workflows/call-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,10 @@ jobs:
- name: Setup Android SDK
uses: android-actions/setup-android@v2

- name: Restore bundle cache
uses: actions/cache@v3
- name: Setup Ruby
uses: ruby/setup-ruby@cd48c8e22733480b66887b42bfeb6c0b88ea1a56
with:
path: vendor/bundle
key: bundle-${{ hashFiles('**/Gemfile.lock') }}

- name: Restore gradle cache
uses: actions/cache@v3
with:
path: |
~/.gradle/caches
~/.gradle/wrapper
key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle', '**/*.gradle.kts') }}
bundler-cache: true

- name: Create release keystore
run: echo "${{ secrets.RELEASE_KEYSTORE }}" | base64 -d > gradle/keystore/release.jks
Expand Down
7 changes: 5 additions & 2 deletions README-JA.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,14 @@ FANBOX には Web 版しかなく、スマートフォンで投稿を閲覧す
- 画像 / ファイル / GIF 形式でダウンロード
- 投稿に含まれるすべての画像をダウンロード
- ファンカードのダウンロード
- クリエイター単位での一括ダウンロード機能
- 広告
- AdMob Native 広告

#### Not Ready...

- クリエイター単位での一括ダウンロード機能
- Pixiv 連携機能
- ウィジェット機能
- 広告系全般

## Architecture
アプリのアーキテクチャ図を示します。 だいぶ複雑になっているので、一部のモジュールや依存関係は省略し、概略を掴める形にしています。
Expand Down Expand Up @@ -120,6 +121,8 @@ graph LR

## Contribute

セットアップはとても簡単で、このリポジトリをクローン氏 `bundle install` するだけです。このアプリは [daifuku](https://github.com/cookpad/daifuku)[Puree](https://github.com/cookpad/puree-kotlin) を用いてログ基盤を作成しています。詳しくはライブラリのドキュメントまたは `./scripts/daifuku` 以下をご覧ください。

このアプリは Gradle の Convention Plugins を用いてビルドのロジックを共通化しており、`build-logic` というモジュールに全てのロジックが記述されています。このアプローチに関しては、[nowinandroid](https://github.com/matsumo0922/nowinandroid/tree/main/build-logic) をご覧ください。

何か不具合を発見したり機能を改善したい場合、機能を新たに開発したい場合は、まず issue を書いてください。その上であなた自身を assign し、開発に取り組んでください。pull request はいつでも歓迎です :smile:
Expand Down
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,14 @@ There was only a web version of FANBOX, which was a bit inconvenient for viewing
- Download in image/file/GIF format.
- Download all images included in a post.
- Download fan cards.
- Bulk download function for individual creators.
- Ads
- AdMob Native Ads

#### Not Ready...

- Bulk download function for individual creators.
- Pixiv integration feature.
- Widget functionality.
- All advertising-related features.

## Architecture
Shows the architecture diagram of the app. It's quite complex, so I've omitted some modules and dependencies to give you an overview.
Expand Down Expand Up @@ -122,11 +123,13 @@ graph LR

## Contribute

Setup is very easy, just clone this repository and `bundle install`. This app uses [daifuku](https:github.comcookpaddaifuku) and [Puree](https:github.comcookpadpuree-kotlin) to create the log infrastructure. For more information, please see the library documentation or `./scripts/daifuku`.

This app uses Gradle's Convention Plugins to standardize the build logic, and all the logic is written in a module called `build-logic`. For information on this approach, see [nowinandroid](https://github.com/matsumo0922/nowinandroid/tree/main/build-logic).

If you find a bug, want to improve a feature, or want to develop a new feature, please first write an issue. Then assign yourself and work on the development. Pull requests are always welcome :smile:

This app is monetized using AdMob. When building manually from GitHub, you need to write the AdMob App ID in `local.properties`. By default it contains a dummy ID, which causes it to crash on startup. Alternatively, please delete the AdMob code and build the app. In addition, various IDs are described in `local.properties`. See `appbuild.gradle.kts` or `PixiViewConfig` for details.
This app is monetized using AdMob. When building manually from GitHub, you need to write the AdMob App ID in `local.properties`. By default it contains a dummy ID, which causes it to crash on startup. Alternatively, please delete the AdMob code and build the app. In addition, various IDs are described in `local.properties`. See `app/build.gradle.kts` or `PixiViewConfig` for details.

## License

Expand Down

0 comments on commit 9f62ce6

Please sign in to comment.