Skip to content

Commit

Permalink
Merge pull request #2 from yahavi/master
Browse files Browse the repository at this point in the history
Update icons and add 'Using the Plugin' section to README
  • Loading branch information
yahavi authored May 10, 2018
2 parents 70aa964 + 5971be2 commit 19e2c5e
Show file tree
Hide file tree
Showing 17 changed files with 32 additions and 12 deletions.
30 changes: 25 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,38 @@ Conan CLion plugin adds Conan support to Jetbrains CLion.
* CLion version 2018.1 and above.
* Conan executable in path environment variable.

# Building and Testing the Sources
To build the plugin sources, please follow these steps:
# Using the Plugin
#### Matching Profiles
Before running the build for the first time, please match a Conan profile to each CMake profile.
To do this click on the *Match profiles* ![Match profiles](src/main/resources/icons/properties.png?raw=true "Match profiles") icon.

![Matching profiles form](src/main/resources/screenshots/matching-profiles.png?raw=true "Matching profiles form")

#### Downloading Conan Dependencies
* The Conan dependencies are automatically downloaded before each CMake build.
However, you can download dependencies manually by clicking on the *install* ![Install](src/main/resources/icons/conan.png?raw=true "Install") or the *Update and install* ![Update and install](src/main/resources/icons/conan-update-install.png?raw=true "Update and install") button.
* ![Install](src/main/resources/icons/conan.png?raw=true "Install") - Installs conan dependencies.
* ![Update and install](src/main/resources/icons/conan-update-install.png?raw=true "Update and install") - Checks updates existence from upstream remotes and installs conan dependencies.

![Install](src/main/resources/screenshots/install.png?raw=true "Install")

#### Config Install
Conan lets you download and use a pre-configured environment. In order to do so, click on *Open configuration* ![Open configuration](src/main/resources/icons/settings.png?raw=true "Open configuration") button, supply your config folder URL, and click download.

![Install](src/main/resources/screenshots/config-install.png?raw=true "Config install")

# Building and Testing the Plugin's Sources
To build and run the plugin sources, please follow these steps:
1. Clone the code from git.
2. If you'd just like to run the tests, run the following command:
2. To run the tests, use the following command:
```
./gradlew clean test
```
3. Build and create the Conan CLion Plugin zip file by running the following gradle command.
3. To Build and create the Conan CLion Plugin zip file, run the following command.
```
./gradlew clean build
```
After the build finishes, you'll find the zip file in the *build/distributions* directory.
After the build process is completed, you'll find the zip file in the *build/distributions* directory.
The zip file can be loaded into CLion.
# Installation
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
pluginVersion = 0.1.1
pluginVersion = 0.1.2
clionVersion = 2018.1.2
2 changes: 1 addition & 1 deletion src/main/java/conan/ui/ConanToolWindow.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
*/
public class ConanToolWindow {

private static final Icon CONAN_ICON = IconLoader.getIcon("/icons/conan_icon.png");
private static final Icon CONAN_ICON = IconLoader.getIcon("/icons/conan.png");
private static final String[] CONAN_ACTIONS = {"ReloadProject", "Install", "UpdateAndInstall", "CleanCache", "MatchProfiles", "CleanConsole", "OpenConfig"};
private ContentManager contentManager;
private Map<ConanProfile, ConsoleView> conanProfileContexts = Maps.newConcurrentMap();
Expand Down
10 changes: 5 additions & 5 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<projectService serviceImplementation="conan.extensions.CMakeRunnerStepImpl"/>
<toolWindow id="Conan"
anchor="bottom"
icon="/icons/conan_icon.png"
icon="/icons/conan.png"
factoryClass="conan.ui.ConanToolWindowFactory"/>
</extensions>

Expand All @@ -42,19 +42,19 @@
class="conan.actions.InstallAction"
text="Install"
description="Install Conan packages"
icon="/icons/conan_icon.png"/>
icon="/icons/conan.png"/>

<action id="Conan.UpdateAndInstall"
class="conan.actions.UpdateAndInstall"
text="Update and install"
description="Update from remotes and install Conan packages"
icon="AllIcons.Actions.Download"/>
icon="/icons/conan-update-install.png"/>

<action id="Conan.CleanCache"
class="conan.actions.CleanCacheAction"
text="Clean cache"
description="Clean Conan cache"
icon="AllIcons.Actions.GC"/>
icon="/icons/trash.png"/>

<action id="Conan.MatchProfiles"
class="conan.actions.MatchProfilesAction"
Expand All @@ -66,7 +66,7 @@
class="conan.actions.CleanConsole"
text="Clean console"
description="Clean console"
icon="AllIcons.Actions.Clean"/>
icon="/icons/brush.png"/>

<action id="Conan.OpenConfig"
class="conan.actions.OpenConfigAction"
Expand Down
Binary file added src/main/resources/icons/brush.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/icons/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/icons/conan-update-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/icons/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added src/main/resources/icons/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/icons/properties.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/icons/settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/icons/trash.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/icons/[email protected]
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/screenshots/config-install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/resources/screenshots/install.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 19e2c5e

Please sign in to comment.