From 6a382dffe74b5be6d2de78cb0c640cc67e9ce650 Mon Sep 17 00:00:00 2001 From: kevinkong Date: Fri, 16 Mar 2018 14:53:02 +0800 Subject: [PATCH] Update README.md --- README.md | 50 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index b5a6e70..2eddd66 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,34 @@ -代码迁移到https://github.com/NetEase/Emmagee ，此处不再维护 -##Emmagee - a practical, handy performance test tool for specified Android App +## Emmagee - a practical, handy performance test tool for specified Android App -Emmagee is a practical, handy performance test tool for specified Android App, which can monitor CPU, memory and -network traffic. Additionally, it also provides several cool features such as customizing interval of collecting data, +Emmagee is a practical, handy performance test tool for specified Android App, which can monitor CPU, memory, +network traffic, battery current and status([Some devices are not supported](https://github.com/NetEase/Emmagee/wiki/Some-devices-are-not-supported)), new features such as top activity and heap size if rooted([Root Toast may continously show](https://github.com/NetEase/Emmagee/wiki/FAQ)), are also supported in the [latest version](https://github.com/NetEase/Emmagee/releases). Additionally, it also provides several cool features such as customizing interval of collecting data, rendering real-time process status in a floating window, and much more. - * Homepage: - * Wiki: - * Issues: + * Homepage: https://github.com/NetEase/Emmagee + * Wiki: https://github.com/NetEase/Emmagee/wiki + * Issues: https://github.com/NetEase/Emmagee/issues + * FAQ: https://github.com/NetEase/Emmagee/wiki/FAQ * Tags: Android, Java -## Features - -* Process-specific monitoring -* Real-time data displaying -* User-defined collecting interval +   ## Why should I use Emmagee? -Unlike other performance test tools that only do system-level monitoring, Emmagee provides the ability to monitor any single App. Other advantages that +Unlike most other performance test tools that only do system-level monitoring, Emmagee provides the ability to monitor any single App. Other advantages that you should not miss: * Open source * Easy to use -* Floating window rendering real-time process status +* Process-specific monitoring, including CPU, memory, network traffic, battery current, launching time and status +* Floating window that renders real-time process status * CSV format report that can be converted into any other format you want +* User-defined collecting interval * Fully support Android 2.2 and above ## How to use Emmagee? +First of all ,you should have Emmagee.apk,download [here](https://github.com/NetEase/Emmagee/releases) or +build the apk file youself [here](https://github.com/NetEase/Emmagee/wiki/How-to-build-emmage.apk%3F),then : + 1. Start Emmagee App 2. Configure interval 3. Select a target process @@ -37,13 +38,32 @@ And Enjoy! If you want to stop the test, just go back to Emmagee and click Stop button. +## Android 5.0 and above + +* `Android 5.0 and above`: getRunningTasks() and getRunningAppProcesses() are deprecated and only return your application process, so it is unable to get TopActivity from Android 5.0. +* `Android 7.0`: Google has restricted access to /proc, and also can not get pid of target application from TOP command in Android 7.0, I am so sorry to tell that 7.0 can not be supported. + +## Coming Soon +* We want you to decide! + +## How to Contribute? + +You are welcome to contribute to Emmagee, meanwhile you'd better follow the rules below + +* It's *NOT* recommended to submit a pull request directly to Emmagee's `master` branch. `develop` branch is more appropriate +* Follow common Java coding conventions +* Put all Java class files under *com.netease* package +* Add the following [license](#license) in each Java class file + ## Contributors * NetEase, Inc. +* [yrom](https://github.com/yrom) +* [LukeOwncloud](https://github.com/LukeOwncloud) ## License (The Apache License) -Copyright (c) 2012-2013 NetEase, Inc. and other contributors +Copyright (c) 2012-2015 NetEase, Inc. and other contributors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. -- GitLab