Readme update (#72)
* Clarify usage and contributor requirements * fix * Update README.md * mention fdroid repo, adress #79
This commit is contained in:
parent
b5c76fefbd
commit
1c715ad23c
20
README.md
20
README.md
|
@ -1,11 +1,25 @@
|
||||||
[![Travis](https://img.shields.io/travis/inorichi/tachiyomi-extensions.svg)](https://travis-ci.org/inorichi/tachiyomi-extensions)
|
[![Travis](https://img.shields.io/travis/inorichi/tachiyomi-extensions.svg)](https://travis-ci.org/inorichi/tachiyomi-extensions)
|
||||||
[![fdroid dev](https://img.shields.io/badge/stable-wiki-blue.svg)](//github.com/inorichi/tachiyomi/wiki/FDroid-for-dev-versions)
|
[![fdroid dev](https://img.shields.io/badge/stable-wiki-blue.svg)](//github.com/inorichi/tachiyomi/wiki/FDroid-for-dev-versions)
|
||||||
|
|
||||||
This repository contains the available extension catalogues for the Tachiyomi app.
|
This repository contains the available extension catalogues for the [Tachiyomi](https://github.com/inorichi/tachiyomi) app.
|
||||||
|
|
||||||
[Download links to be added]
|
# Usage
|
||||||
|
|
||||||
### Writing an extension
|
Extension sources are considered pre-release. They are installed and uninstalled like apps, in .apk format. The plan is to have a UI in the main app, that will enable installing and updating extensions. If you want to try them now regardless, you can use the [F-Droid repo for dev versions](//github.com/inorichi/tachiyomi/wiki/FDroid-for-dev-versions).
|
||||||
|
|
||||||
|
## Requests
|
||||||
|
|
||||||
|
Site requests here are meant as up-for-grabs, thus it's impossible to provide a time estimation for any of them. Furthermore, some sites are impossible to do, usually because of various technical reasons.
|
||||||
|
|
||||||
|
# Contributing
|
||||||
|
|
||||||
|
Before you start, please note that the ability to use following technologies is **required** and it's not possible for us to teach you any of them.
|
||||||
|
* Kotlin
|
||||||
|
* JSoup
|
||||||
|
* HTML
|
||||||
|
* CSS selectors
|
||||||
|
|
||||||
|
## Writing an extension
|
||||||
|
|
||||||
The easiest way to write and debug an extension is by directly hardcoding it in Tachiyomi's source code. Once it's working there, you have to clone this repository and create a new folder with a similar structure to the other catalogues. Then copy your catalogue implementation and make sure to change the package name if it was different in Tachiyomi. Finally, write the `build.gradle` file, which has the following structure:
|
The easiest way to write and debug an extension is by directly hardcoding it in Tachiyomi's source code. Once it's working there, you have to clone this repository and create a new folder with a similar structure to the other catalogues. Then copy your catalogue implementation and make sure to change the package name if it was different in Tachiyomi. Finally, write the `build.gradle` file, which has the following structure:
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue