README.md

Galgo

A tiny Android library for those moments when you want your logs to be displayed on screen.

Abstract

Sometimes we want/need to know what's going on behind the scenes but our app is not always connected to our computer to let us check the logs. Galgo will let you display your log messages as an overlay on top of your UI.

Extremely useful for testers who want to have more insight into what's going on behind the scenes in our apps when it misbehaves.

You can also define some basic settings such as background color, text color, text size and number of lines to display on screen so it better fits your needs.

How to download and Install

Add the following to your build.gradle file:

repositories {
	maven {
		url "https://jitpack.io"
	}
}

dependencies {
	// ...
    compile 'com.github.inaka:galgo:v1.0.2'
    // ...
}

Another option is to simply clone this repo and import it into Android Studio as a module.

Code Example

public class ExampleActivity extends Activity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_example);

        // add some customization to the log messages
        GalgoOptions options = new GalgoOptions.Builder()
                .numberOfLines(15)
                .backgroundColor(Color.parseColor("#D9d6d6d6"))
                .textColor(Color.BLACK)
                .textSize(15)
                .build();
        Galgo.enable(this, options);

        Galgo.log("I am a log message");
    }

    public void onDestroy() {
        super.onDestroy();

        // always call disable to avoid memory leaks
        Galgo.disable(this);
    }
}

Example

Here's an example of the log messages being displayed on top of our Activity:

Contact Us

If you find any bugs or have a problem while using this library, please open an issue in this repo (or a pull request :)).