c6363f3061
docs: Revamp README and add APK naming convention This commit introduces a complete overhaul of the `README.md` to improve project presentation. Key changes include: * Adds a new header with the app icon and a Google Play badge. * Updates the feature graphic and includes a note distinguishing the OSS version from the Play Store version. * Refines the "Open Source Libraries" section to be more structured. * Moves the main preview image into the `docs` directory. Additionally, the `app/build.gradle.kts` file is updated to configure a standardized naming convention for output APK files, including flavor, version, and build type. * refactor copyright headers and fix README icon alignment This commit introduces two main changes across the codebase: The `spotless/copyright.kt` template have been updated for consistency: * The author name is simplified from "Episteme Authors" to "Episteme". * The contact email prefix is shortened from "Electronic mail:" to "mail:". Second, the `README.md` file is adjusted to correct the vertical alignment of the app icon with the project title.
61 lines
No EOL
2 KiB
Kotlin
61 lines
No EOL
2 KiB
Kotlin
/*
|
|
* Episteme Reader - A native Android document reader.
|
|
* Copyright (C) 2026 Episteme
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Affero General Public License as
|
|
* published by the Free Software Foundation, either version 3 of the
|
|
* License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Affero General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
* mail: epistemereader@gmail.com
|
|
*/
|
|
package com.aryan.reader.paginatedreader
|
|
|
|
import timber.log.Timber
|
|
import coil.decode.DataSource
|
|
import coil.decode.ImageSource
|
|
import coil.fetch.FetchResult
|
|
import coil.fetch.Fetcher
|
|
import coil.fetch.SourceResult
|
|
import coil.request.Options
|
|
import okio.Buffer
|
|
|
|
/**
|
|
* A custom data class to wrap raw SVG string content.
|
|
* This avoids conflicts with Coil's default String fetcher.
|
|
*/
|
|
data class SvgData(val content: String)
|
|
|
|
/**
|
|
* A custom Coil Fetcher that handles loading SVG data from our [SvgData] class.
|
|
*/
|
|
class SvgStringFetcher(
|
|
private val options: Options,
|
|
private val data: SvgData,
|
|
) : Fetcher {
|
|
|
|
override suspend fun fetch(): FetchResult {
|
|
Timber.d("SvgStringFetcher: fetching SVG data from SvgData object.")
|
|
val buffer = Buffer().writeUtf8(data.content)
|
|
return SourceResult(
|
|
source = ImageSource(buffer, options.context),
|
|
mimeType = "image/svg+xml",
|
|
dataSource = DataSource.MEMORY
|
|
)
|
|
}
|
|
|
|
class Factory : Fetcher.Factory<SvgData> {
|
|
override fun create(data: SvgData, options: Options, imageLoader: coil.ImageLoader): Fetcher {
|
|
Timber.d("SvgStringFetcher.Factory: create called for SvgData.")
|
|
return SvgStringFetcher(options, data)
|
|
}
|
|
}
|
|
} |