Skip to content

Commit

Permalink
refactor docs
Browse files Browse the repository at this point in the history
  • Loading branch information
devoncarew committed Aug 12, 2016
1 parent 4ff0a02 commit 119a8ca
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 26 deletions.
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Contributing code

We gladly accept contributions via GitHub pull requests!

You must complete the
[Contributor License Agreement](https://cla.developers.google.com/clas).
You can do this online, and it only takes a minute. If you've never submitted code before,
you must add your (or your organization's) name and contact info to the [AUTHORS](AUTHORS)
file.

## Flutter plugin development

First, set up Dart plugin development as described in the
[ReadMe.txt](https://github.com/JetBrains/intellij-plugins/blob/master/Dart/ReadMe.txt)
file in the Dart plugin.

* Open intellij-community project in IntelliJ, compile it.
- Open File | Project Structure | Modules | [+] | Import Module, select
flutter-intellij/flutter-intellij-community.iml (from same dir as this README).
- In the same Project Structure dialog open the Dependencies tab of the community-main module,
click [+] at the bottom (Mac) or right (Win/Linux) to add a module dependency on the
flutter-intellij-community module.
* Install Flutter from [github](https://github.com/flutter/flutter) and set it up according
to its instructions.
* Verify installation from the command line:
- Connect an android device with USB debugging.
- `cd <flutter>/examples/hello_world`
- `flutter doctor`
- `flutter run`
* Verify installation of the Flutter plugin:
- Select IDEA in the Run Configuration drop-down list.
- Click Debug button (to the right of that drop-down).
- In the new IntelliJ process that spawns, open the hello_world example.
- Choose Edit Configuration in the Run Configuration drop-down list.
- Example Defaults and verify that Flutter is present.
- Click [+] and verify that Flutter is present.
27 changes: 2 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,3 @@
### Flutter plugin development ###
## Flutter IntelliJ Plugin

First, set up Dart plugin development as described in the
[ReadMe.txt](https://github.com/JetBrains/intellij-plugins/blob/master/Dart/ReadMe.txt)
file in the Dart plugin.

* Open intellij-community project in IntelliJ, compile it.
- Open File | Project Structure | Modules | [+] | Import Module,
select flutter-intellij/flutter-intellij-community.iml (from same dir as this README).
- In the same Project Structure dialog open the Dependencies tab
of the community-main module, click [+] at the bottom (Mac) or
right (Win/Linux) to add a module dependency on the flutter-intellij-community module.
* Install Flutter from [github](https://github.com/flutter/flutter) and set it up according
to its instructions.
* Verify installation from the command line:
- Connect an android device with USB debugging.
- `cd <flutter>/examples/hello_world`
- `flutter doctor`
- `flutter run`
* Verify installation of the Flutter plugin:
- Select IDEA in the Run Configuration drop-down list.
- Click Debug button (to the right of that drop-down).
- In the new IntelliJ process that spawns, open the hello_world example.
- Choose Edit Configuration in the Run Configuration drop-down list.
- Example Defaults and verify that Flutter is present.
- Click [+] and verify that Flutter is present.
An IntelliJ plugin for Flutter development. More details to follow :)
11 changes: 10 additions & 1 deletion building.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
## Building the plugin

To build the plugin, install gradle. Then, type:
We use gradle to build the plugin, and require version 2.1 or greater (`gradle -version`).

To build the plugin, type:

```
gradle build
Expand All @@ -16,3 +18,10 @@ build/libs/flutter-intellij-0.0.1.jar

Documentation for the options in `gradle.properties` is available at
[github.com/JetBrains/gradle-intellij-plugin](https://github.com/JetBrains/gradle-intellij-plugin).

## Other commands

- `gradle tasks` - get a list of available gradle tasks
- `gradle build` - build the plugin
- `gradle clean` - delete the `build/` directory
- `gradle test` - run the plugin tests

0 comments on commit 119a8ca

Please sign in to comment.