Update README.

PaIn22152 · Sep 13, 2015 · c2396d5 · c2396d5
1 parent 2b377cd
commit c2396d5
Show file tree

Hide file tree

Showing 2 changed files with 254 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,116 @@
 #AndroidResideMenu
 ------
+### 中文说明请点击 [这里][1]
 
-The idea of ResideMenu is from Dribble [1] and [2]. It has come true and run in iOS devices. [iOS ResideMenu][3]
-This project is the ResideMenu Android version. The visual effect is partly referred to iOS version of ResideMenu.
+The idea of ResideMenu is from Dribble [1][2] and [2][3]. It has come true and run in iOS devices. [iOS ResideMenu][4]
+This project is the RefsideMenu Android version. The visual effect is partly referred to iOS version of ResideMenu.
 And thanks to the authors for the above idea and contribution.
-
+<img src="https://github.com/SpecialCyCi/AndroidResideMenu/raw/master/1.png" width="320" height="568" />
 <img src="https://github.com/SpecialCyCi/AndroidResideMenu/raw/master/2.gif" width="320" height="568" />
 
-## Fixes
-[Overlapping Soft NavigationBar to contentUI][4]
+Now with 3D support !
+<img src="https://github.com/SpecialCyCi/AndroidResideMenu/raw/master/3Dsupport.png" width="320" height="568" />
+## DEMO
+This copy is the demo.
+
+## Version Migration
+
+#### Upgrading to `v1.4` from `v1.3`, `v1.2`, `v1.1`, `v1.0` 
+
+Duplicate the followed code in dispatchTouchEvent() of Activity, replace the old `dispatchTouchEvent()` code.
+
+```java
+    @Override
+    public boolean dispatchTouchEvent(MotionEvent ev) {
+        return resideMenu.dispatchTouchEvent(ev);
+    }
+```
+
+## Requirements
+
+Run in Android 2.3 +
+
+## Installation
+
+### Gradle
+
+```gradle
+repositories {
+    mavenCentral()
+}
+dependencies {
+    compile 'com.specyci:residemenu:1.6+'
+}
+```
+
+### Other
+
+ 1. import ResideMenu project to your workspace.
+ 2. make it as a dependency library project to your main project.
+<br>**( see [example][5] )**
+
+**or**
+
+If you want to merge ResideMenu with your project, you should follow these steps.
+
+ 1. Copy all files from src/com/special/ResideMenu to your project.
+ 2. Copy libs/nineoldandroids-library-2.4.0.jar to your project’s corresponding path: libs/
+ 3. Copy res/drawable-hdpi/shadow.9.png to your project’s corresponding path: res/drawable-hdpi/
+ 4. Copy res/layout/residemenu.xml and residemenu_item.xml to your project’s corresponding path: res/layout
+
+## Usage
+init ResideMenu: write these code in Activity onCreate()
+```java
+        // attach to current activity;
+        resideMenu = new ResideMenu(this);
+        resideMenu.setBackground(R.drawable.menu_background);
+        resideMenu.attachToActivity(this);
+
+        // create menu items;
+        String titles[] = { "Home", "Profile", "Calendar", "Settings" };
+        int icon[] = { R.drawable.icon_home, R.drawable.icon_profile, R.drawable.icon_calendar, R.drawable.icon_settings };
+
+        for (int i = 0; i < titles.length; i++){
+            ResideMenuItem item = new ResideMenuItem(this, icon[i], titles[i]);
+            item.setOnClickListener(this);
+            resideMenu.addMenuItem(item,  ResideMenu.DIRECTION_LEFT); // or  ResideMenu.DIRECTION_RIGHT
+        }
+```
+If you want to use slipping gesture to operate(lock/unlock) the menu, override this code in Acitivity dispatchTouchEvent() (please duplicate the followed code in dispatchTouchEvent() of Activity.
+```java
+    @Override
+    public boolean dispatchTouchEvent(MotionEvent ev) {
+        return resideMenu.dispatchTouchEvent(ev);
+    }
+```
+**On some occasions, the slipping gesture function for locking/unlocking menu, may have conflicts with your widgets, such as viewpager. By then you can add the viewpager to ignored view, please refer to next chapter – Ignored Views.**
+
+open/close menu
+```java
+resideMenu.openMenu(ResideMenu.DIRECTION_LEFT); // or ResideMenu.DIRECTION_RIGHT
+resideMenu.closeMenu();
+```
+
+listen in the menu state
+```java
+    resideMenu.setMenuListener(menuListener);
+    private ResideMenu.OnMenuListener menuListener = new ResideMenu.OnMenuListener() {
+        @Override
+        public void openMenu() {
+            Toast.makeText(mContext, "Menu is opened!", Toast.LENGTH_SHORT).show();
+        }
+
+        @Override
+        public void closeMenu() {
+            Toast.makeText(mContext, "Menu is closed!", Toast.LENGTH_SHORT).show();
+        }
+    };
+```
 
-## [Default Usage][5]
+disable a swipe direction
+```java
+  resideMenu.setSwipeDirectionDisable(ResideMenu.DIRECTION_RIGHT);
+```
 
 ## Custom Usage
 
@@ -35,8 +135,22 @@ As your configuration's completed, now you can customize side menus by getting i
         // TODO: Do whatever you need to with rightMenu
 ```
 
-  [1]: http://dribbble.com/shots/1116265-Instasave-iPhone-App
-  [2]: http://dribbble.com/shots/1114754-Social-Feed-iOS7
-  [3]: https://github.com/romaonthego/RESideMenu
-  [4]: https://github.com/SpecialCyCi/AndroidResideMenu/issues/68
-  [5]: https://github.com/SpecialCyCi/AndroidResideMenu#usage
+##Ignored Views
+On some occasions, the slipping gesture function for locking/unlocking menu, may have conflicts with your widgets such as viewpager.By then you can add the viewpager to ignored view.
+```java
+        // add gesture operation's ignored views
+        FrameLayout ignored_view = (FrameLayout) findViewById(R.id.ignored_view);
+        resideMenu.addIgnoredView(ignored_view);
+```
+So that in ignored view’s workplace, the slipping gesture will not be allowed to operate menu.
+
+##About me
+A student from SCAU China.<br>
+Email: specialcyci#gmail.com
+
+
+  [1]: https://github.com/SpecialCyCi/AndroidResideMenu/blob/master/README_CN.md
+  [2]: http://dribbble.com/shots/1116265-Instasave-iPhone-App
+  [3]: http://dribbble.com/shots/1114754-Social-Feed-iOS7
+  [4]: https://github.com/romaonthego/RESideMenu
+  [5]: https://github.com/SpecialCyCi/AndroidResideMenu/blob/master/ResideMenuDemo/project.properties
diff --git a/README_CN.md b/README_CN.md
@@ -0,0 +1,129 @@
+#AndroidResideMenu
+
+------
+
+ReisdeMenu 创意灵感来自于Dribbble[1][1]还有[2][2]，而这个是Android版的ResideMenu，在视觉效果上部分参考了[iOS版的RESideMenu][3]，并在此感谢以上作者的贡献。
+<img src="https://github.com/SpecialCyCi/AndroidResideMenu/raw/master/1.png" width="320" height="568" />
+<img src="https://github.com/SpecialCyCi/AndroidResideMenu/raw/master/2.gif" width="320" height="568" />
+
+## DEMO
+
+本代码即是DEMO，您可以下载后选择您喜欢的IDE运行。SDK版本建议使用4.0以上
+
+## Version Migration
+
+#### 从 `v1.0`, `v1.1`, `v1.2`, `v1.3` 升级到 `v1.4`
+
+如果你开启了手势滑动，你需要替换被依附的 Activity 里 `dispatchTouchEvent()` 代码
+
+```java
+    @Override
+    public boolean dispatchTouchEvent(MotionEvent ev) {
+        return resideMenu.dispatchTouchEvent(ev);
+    }
+```
+
+## Requirements
+
+运行在 Android 2.3 +
+
+## Installation
+
+### Gradle
+
+```gradle
+repositories {
+    mavenCentral()
+}
+dependencies {
+    compile 'com.specyci:residemenu:1.6+'
+}
+```
+
+### Other
+
+ 直接导入ResideMenu项目并作为依赖项目<br>
+ **[例子][6]**
+
+**or**
+ 直接合并到您的项目之中
+
+ 1. 复制src/com/special/ResideMenu下的所有代码到您的项目相应位置
+ 2. 复制libs/nineoldandroids-library-2.4.0.jar到您项目libs/下
+ 3. 复制res/drawable-hdpi/shadow.9.png到您的项目相应位置
+ 4. 复制res/layout/residemenu.xml 和 residemenu_item.xml到您的项目相应位置
+
+## Usage
+写在Activity onCreate()中
+```java
+        // attach to current activity;
+        resideMenu = new ResideMenu(this);
+        resideMenu.setBackground(R.drawable.menu_background);
+        resideMenu.attachToActivity(this);
+
+        // create menu items;
+        String titles[] = { "Home", "Profile", "Calendar", "Settings" };
+        int icon[] = { R.drawable.icon_home, R.drawable.icon_profile, R.drawable.icon_calendar, R.drawable.icon_settings };
+
+        for (int i = 0; i < titles.length; i++){
+            ResideMenuItem item = new ResideMenuItem(this, icon[i], titles[i]);
+            item.setOnClickListener(this);
+            resideMenu.addMenuItem(item,  ResideMenu.DIRECTION_LEFT); // or  ResideMenu.DIRECTION_RIGHT
+        }
+```
+如果您需要使用手势滑动开启/关闭菜单，请复写activity的dispatchTouchEvent()，代码如下
+```java
+    @Override
+    public boolean dispatchTouchEvent(MotionEvent ev) {
+        return resideMenu.dispatchTouchEvent(ev);
+    }
+```
+**在某些场景下，手势滑动开启/关闭菜单可能与您的某些控件产生冲突，例如viewpager，这时您可以把viewpager添加到ignored view.请参见下节Ignored Views**
+
+开启/关闭菜单
+open or close menu
+```java
+resideMenu.openMenu(ResideMenu.DIRECTION_LEFT); // or ResideMenu.DIRECTION_RIGHT
+resideMenu.closeMenu();
+```
+监听菜单状态
+```java
+    resideMenu.setMenuListener(menuListener);
+    private ResideMenu.OnMenuListener menuListener = new ResideMenu.OnMenuListener() {
+        @Override
+        public void openMenu() {
+            Toast.makeText(mContext, "Menu is opened!", Toast.LENGTH_SHORT).show();
+        }
+
+        @Override
+        public void closeMenu() {
+            Toast.makeText(mContext, "Menu is closed!", Toast.LENGTH_SHORT).show();
+        }
+    };
+```
+
+禁止手势操作某个菜单方向
+```java
+  resideMenu.setSwipeDirectionDisable(ResideMenu.DIRECTION_RIGHT);
+```
+
+
+##Ignored Views
+在某些场景下，手势滑动开启/关闭菜单可能与您的某些控件产生冲突，例如viewpager，这时您可以把viewpager添加到ignored view.
+```java
+        // add gesture operation's ignored views
+        FrameLayout ignored_view = (FrameLayout) findViewById(R.id.ignored_view);
+        resideMenu.addIgnoredView(ignored_view);
+```
+这样子在ignored_view操作的区域就不允许用手势滑动操作菜单.
+
+##About me
+A student from SCAU China.<br>
+Email: specialcyci#gmail.com
+
+[1]: http://dribbble.com/shots/1116265-Instasave-iPhone-App
+[2]: http://dribbble.com/shots/1114754-Social-Feed-iOS7
+[3]: https://github.com/romaonthego/RESideMenu
+[4]: http://dribbble.com/shots/1116265-Instasave-iPhone-App
+[5]: http://dribbble.com/shots/1114754-Social-Feed-iOS7
+[6]: https://github.com/SpecialCyCi/AndroidResideMenu/blob/master/ResideMenuDemo/project.properties