Skip to content

Commit bd71b65

Browse files
committed
Add usage instructions.
1 parent e16cfaf commit bd71b65

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,20 @@
88

99
<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/0/01/Created_with_Matplotlib-logo.svg/128px-Created_with_Matplotlib-logo.svg.png" alt="Created with Matplotlib" align="left"/> The Java 8 Stream API sets forth a promising new programming model that incorporates functional-like, MapReduce-style features into a mainstream programming language. However, using streams efficiently may involve subtle considerations.
1010

11-
This tool consists of automated refactoring research prototype plug-ins for [Eclipse](http://eclipse.org) that assists developers in writing optimal stream client code in a semantics-preserving fashion. Refactoring preconditions and transformations for automatically determining when it is safe and possibly advantageous to convert a sequential stream to parallel and improve upon already parallel streams are included. The approach utilizes both [WALA][wala] and [SAFE][safe].
11+
This tool consists of automated refactoring research prototype plug-ins for [Eclipse][eclipse] that assists developers in writing optimal stream client code in a semantics-preserving fashion. Refactoring preconditions and transformations for automatically determining when it is safe and possibly advantageous to convert a sequential stream to parallel and improve upon already parallel streams are included. The approach utilizes both [WALA][wala] and [SAFE][safe].
12+
13+
## Usage
14+
15+
The refactoring can be run in two different ways:
16+
17+
1. As a command.
18+
1. Select a project.
19+
1. Select "Optimize Streams..." from the "Quick Access" dialog (CTRL-3).
20+
1. As a menu item.
21+
1. Right-click on a project.
22+
1. Under "Refactor," choose "Optimize Streams..."
23+
24+
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 streams in the enclosing projects to refactor.
1225

1326
## Installation
1427

@@ -48,6 +61,7 @@ See the [wiki][wiki] for further information. For information on contributing, s
4861

4962
[wiki]: https://github.com/ponder-lab/Java-8-Stream-Refactoring/wiki
5063
[annotations]: https://github.com/ponder-lab/edu.cuny.hunter.streamrefactoring.annotations
64+
[eclipse]: http://eclipse.org
5165
[wala]: https://github.com/wala/WALA
5266
[safe]: https://github.com/tech-srl/safe
5367
[contrib]: https://github.com/ponder-lab/Optimize-Java-8-Streams-Refactoring/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)