-
Notifications
You must be signed in to change notification settings - Fork 27
Getting started
We expect developers to have some experience in Java and Android programming. In case you dont have the necessary skills, but are willing to learn them, please refer to the following links:
- You can learn Java from this book Head First Java.
- You can learn Android programming from here
You need to have latest version of JDK/JRE installed on your machine. You can get it installed from here.
You need to have android sdk installed on our machine. You can do so by following the instructions in this page.
Install Android 2.1 (API 7)
We recommend using Eclipse as the IDE for the development purposes. You can get it here
Ofcourse! We are using git as our SCM software :). You can get git installed from here
Please refer to their documentation here
In case you dont have one. You can do so from here. It is free of cost!
In order to contribute to the code-base:
- You will have to fork the ComicReader project first.
- Make changes in your local branch of ComicReader.
- When you want to submit these changes back to the main branch, just create a pull request.
Please do note that it might about a week for us to get back on the pull requests you have sent. So, please be patient and co-operate with us on this regard.
All classes in ComicReader have the root package to be: 'com.blogspot.applications4android.comicreader'.
- ComicReader -- this is the actual app codebase.
- ComicReaderTest -- contains Android JUnit tests for some of the core classes in ComicReader.
- list_all_gocomics_mod.pl -- this is a perl script which is responsible for creating a list of all gocomics comic series and creating a class for comic they support!
- For now you can ignore all other files in the root directory of the project.
- com.blogspot.applications4android.comicreader -- contains all activity/receiver classes responsible for interacting directly with the users.
- com.blogspot.applications4android.comicreader.comics -- contains all comics supported by this app
- com.blogspot.applications4android.comicreader.comictypes -- contains abstract classes for different 'types' of comics supported by this app. Comics are divided into different types based on the common patterns in their websites (how do they navigate between next/prev/random strips? how are the strips organized? etc)
- com.blogspot.applications4android.comicreader.core -- All of the core logic for this app
- com.blogspot.applications4android.comicreader.exceptions -- All exceptions thrown by this app
- com.blogspot.applications4android.comicreader.numpicker -- Contains the Number Picker Dialog logic
- com.blogspot.applications4android.comicreader.zoom -- contains logic to zoom in/out of a strip
- assets/classes.json -- this is the main json file which contains the list of all comics currently supported.