Progress.

Author: khatchad

CONTRIBUTING.md

@@ -39,16 +39,8 @@ Dependency | Update Site
 [PyDev] | https://raw.githubusercontent.com/ponder-lab/Pydev/pydev_9_3/org.python.pydev.updatesite
 [WALA] | https://raw.githubusercontent.com/ponder-lab/WALA/v1.6/com.ibm.wala-repository
 
-## Running the Evaluator
-
-Use the `edu.cuny.hunter.hybridize.evaluator` plug-in project to run the evaluation. The evaluator will output several CSV files with the results of the evaluation. For convenience, there is an [Eclipse launch configuration](https://wiki.eclipse.org/FAQ_What_is_a_launch_configuration%3F) that can be used to run the evaluation. The run configuration is named [`edu.cuny.hunter.hybridize.eval/Evaluate Hybridize Functions.launch`](https://github.com/ponder-lab/Hybridize-Functions-Refactoring/blob/691cbeb87be805b8bfc336e799d938a9064a5e0e/edu.cuny.hunter.hybridize.eval/Evaluate%20Hybridize%20Functions.launch). In the run configuration dialog, you can specify several arguments to the evaluator as system properties.
-
-### Configuring the Evaluation
-
-More info can be found on [this wiki page][evaluator wiki].
 
 [wiki]: https://github.com/ponder-lab/Hybridize-Functions-Refactoring/wiki
-[evaluator wiki]: https://github.com/ponder-lab/Hybridize-Functions-Refactoring/wiki/Running-the-Evaluator
 [PyDev]: https://github.com/ponder-lab/Pydev/tree/pydev_9_3
 [Common Eclipse Refactoring Framework]: https://github.com/ponder-lab/Common-Eclipse-Refactoring-Framework
 [Ariadne]: https://github.com/ponder-lab/ML

README.md

@@ -18,7 +18,25 @@ Coming soon!
 
 ## Usage
 
-Coming soon!
+### General Usage
+
+The refactoring can be run in two different ways:
+
+1. As a command.
+    1. Select a project.
+    1. Select "Hybridize function..." from the "Quick Access" dialog (CTRL-3).
+1. As a menu item.
+    1. Right-click on a project.
+    1. Under "Refactor," choose "Hybridize function..."
+
+Currently, the refactoring works only via the package explorer and the outline views. You can either select a single project to optimize or select multiple projects. In each case, the tool will find functions in the enclosing projects to refactor.
+
+### Running the Evaluator
+
+Use the `edu.cuny.hunter.hybridize.evaluator` plug-in project to run the evaluation. The evaluation process will produce several CSVs, as well as perform the transformation if desired (see below for details). The evaluator will output several CSV files with the results of the evaluation. For convenience, there is an [Eclipse launch configuration](https://wiki.eclipse.org/FAQ_What_is_a_launch_configuration%3F) that can be used to run the evaluation. The run configuration is named [`edu.cuny.hunter.hybridize.eval/Evaluate Hybridize Functions.launch`](https://github.com/ponder-lab/Hybridize-Functions-Refactoring/blob/691cbeb87be805b8bfc336e799d938a9064a5e0e/edu.cuny.hunter.hybridize.eval/Evaluate%20Hybridize%20Functions.launch). In the run configuration dialog, you can specify several arguments to the evaluator as system properties.
+
+You can run the evaluator in several different ways, including as a command or as a menu item, which is shown in the menu bar. Either way, you must evaluate *entire* projects, as the evaluator will collect project-level data. Information on configuring the evaluator can be found on [this wiki page][evaluator wiki].
+
 
 ## Installation
 
@@ -37,6 +55,7 @@ Coming soon!
 For information on contributing, see [CONTRIBUTING.md][contrib].
 
 [wiki]: https://github.com/ponder-lab/Hybridize-Functions-Refactoring/wiki
+[evaluator wiki]: https://github.com/ponder-lab/Hybridize-Functions-Refactoring/wiki/Running-the-Evaluator
 [eclipse]: http://eclipse.org
 [contrib]: https://github.com/ponder-lab/Hybridize-Functions-Refactoring/blob/main/CONTRIBUTING.md
 [pydev]: http://www.pydev.org/