Improvements for Tools/xcodedump.rb

.github/CONTRIBUTING.md

@@ -1,2 +1,43 @@
 
-# Contributing
+## Bug issue handling 
+
+  Reported bugs are handled following order.
+
+  1. Confirm if the bug reproduce and the issue labeled as 'Bug'
+  2. Fix the bug in 'develop' branch
+  3. Confirm the fix by the reporter
+  4. The issue is labeled 'Done'
+  5. Confirm that the fix does not make another side effect.
+  6. Merged into 'master'
+  7. The issue is closed.
+
+  This order is only applied to 'Bug' issues.
+
+## Contributions
+  Any suggestions, bug reports or feature requests are welcome.
+
+  If you want to add a feature or fix bugs by yourself the following videos are good help for you.
+ - [How to get debug log](http://www.youtube.com/watch?v=50Bhu8setlc)
+ - [How to debug XVim](http://www.youtube.com/watch?v=AbC6f86VW9A)
+ - [How to write a test case](http://www.youtube.com/watch?v=kn-kkRTtRcE)
+
+  Any pull requests are very much appreciated. Before you make a pull request see [Make a Pull Request](Documents/Developers/PullRequest.md)
+
+Watch the videos mentioned earlier for a full tutorial on developing, debugging and testing XVim. Here is a very simple guide to get you started.
+
+### Debugging
+  1. Make sure you have Xcode.app installed at /Applications/Xcode.app, if that's true just open XVim.xcodeproj and Run (CMD + R). You can ignore the rest steps.
+  2. If you have Xcode installed at a different path, follow these steps.
+  3. Open XVim.xcodeproj
+  4. Got to Edit Scheme... => Run => Executable => Other => Choose The Xcode.app you installed to.
+  5. Run (CMD + R)
+
+### Run Unit Tests
+  1. In your .xvimrc, add a line "set debug", which tells XVim to run in debug mode.
+  2. Open XVim.xcodeproj, a debug instance of Xcode shows up.
+  3. In the debug Xcode instance, create a random small disposable project (say HelloWorld.xcodeproj) if you have don't this already.
+  4. Open HelloWorld.xcodeproj using debug Xcode instance.
+  5. Go to XVim menu, there should be an item "test categories"
+  6. Choose a category to run
+  7. A separate window shows up and unit tests are run inside that window.
+  8. Results will be shown when all the tests in that category are completed.

.github/ISSUE_TEMPLATE.md

@@ -1,2 +1,29 @@
+<!---
+For installation problem, please obey the instruction in README.md to install XVim. Then if you still have problem, report it.
+
+Fill the following [] for a bug issue. 
+Fill the blanks as possible as you can.
+Write freely if it is other issues, like feature request.
+
+
+--->
+
+# Description
+[Write simple description here. If the title describes it well, just delete this.]
+
+# Operation
+[Describe the operation you did. Also include your text on which you operate if it is related to text editing.]
+
+# Expected behaviour
+[Write here]
+
+# Environments
+  - Xcode Version [    ]
+  - XVim branch and revision [     ]
+  - Keyboard Language [     ]
+  - Input source language [    ]
+
+# Crash log (if any)
+
+     [ Paste the log here ]
 
-# Issue Template

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,2 +1,11 @@
+<!---
+Please check the following before you make PR.
 
-# PR Template
+   1. Pull Request should be made to 'develop' branch
+   2. Run all the unit test cases and check nothing fails.
+   3. Write a unit test for your newly added or modified code.
+   4. Rewrite Documents/Users/FeatureList.md as needed.
+
+See Documents/Developers/PullRequest.md for the detailed explanation.
+Thank you!
+--->

README.md

@@ -16,10 +16,29 @@
 
 ## INSTALL
   Download source code or clone the repo. Then,
+
+  1. Confirm `xcode-select` points to your Xcode
+  ```bash
+  $ xcode-select -p
+  /Applications/Xcode.app/Contents/Developer
+  ```
+
+  If this doesn't show your Xcode application path, use `xcode-select -s` to set.
+
+  2. make
   ```bash
   $ make
   ```
-  Create `.xvimrc` as you need and restart your Xcode. 
+
+  If you see something like 
+
+  ```
+  XVim hasn't confirmed the compatibility with your Xcode, Version X.X
+  Do you want to compile XVim with support Xcode Version X.X at your own risk? 
+  ```
+  Press y if you want to use XVim with your Xcode version (even it is not confirmed it works)
+
+  3. Create `.xvimrc` as you need and restart your Xcode. 
 
 ## Branches and Releases
  XVim has several branches and releases. Usually you only need to download one of 'releases' and use it.
@@ -65,48 +84,8 @@ Delete the following directory:
 
   https://www.bountysource.com/teams/xvim
 
-## Bug issue handling 
-
-  Reported bugs are handled following order.
-
-  1. Confirm if the bug reproduce and the issue labeled as 'Bug'
-  2. Fix the bug in 'develop' branch
-  3. Confirm the fix by the reporter
-  4. The issue is labeled 'Done'
-  5. Confirm that the fix does not make another side effect.
-  6. Merged into 'master'
-  7. The issue is closed.
-
-  This order is only applied to 'Bug' issues.
-
-## Contributions
-  Any suggestions, bug reports or feature requests are welcome.
-
-  If you want to add a feature or fix bugs by yourself the following videos are good help for you.
- - [How to get debug log](http://www.youtube.com/watch?v=50Bhu8setlc)
- - [How to debug XVim](http://www.youtube.com/watch?v=AbC6f86VW9A)
- - [How to write a test case](http://www.youtube.com/watch?v=kn-kkRTtRcE)
-
-  Any pull requests are very much appreciated. Before you make a pull request see [Make a Pull Request](Documents/Developers/PullRequest.md)
-
-Watch the videos mentioned earlier for a full tutorial on developing, debugging and testing XVim. Here is a very simple guide to get you started.
-
-### Debugging
-  1. Make sure you have Xcode.app installed at /Applications/Xcode.app, if that's true just open XVim.xcodeproj and Run (CMD + R). You can ignore the rest steps.
-  2. If you have Xcode installed at a different path, follow these steps.
-  3. Open XVim.xcodeproj
-  4. Got to Edit Scheme... => Run => Executable => Other => Choose The Xcode.app you installed to.
-  5. Run (CMD + R)
-
-### Run Unit Tests
-  1. In your .xvimrc, add a line "set debug", which tells XVim to run in debug mode.
-  2. Open XVim.xcodeproj, a debug instance of Xcode shows up.
-  3. In the debug Xcode instance, create a random small disposable project (say HelloWorld.xcodeproj) if you have don't this already.
-  4. Open HelloWorld.xcodeproj using debug Xcode instance.
-  5. Go to XVim menu, there should be an item "test categories"
-  6. Choose a category to run
-  7. A separate window shows up and unit tests are run inside that window.
-  8. Results will be shown when all the tests in that category are completed.
+## Contributing Guidelines
+  See separate [CONTRIBUTING.md](.github/CONTRIBUTING.md)
 
 ## Donations
   If you think the plugin is useful, please donate.

Tools/xcodedump.rb

@@ -22,8 +22,8 @@ def list_frameworks(directory, rel_dir, &block)
             next
         elsif is_framework(path)
             block.call(path, rel_dir)
-        elsif File.directory?(path)
-                list_frameworks(path, rel_dir + "/" + x, &block)
+        elsif File.directory?(path) and !(/\.platform$/ =~ path or /\.app$/ =~ path)
+            list_frameworks(path, rel_dir + "/" + x, &block)
         end
     }
 end