Skip to content

Commit 29fa493

Browse files
francoiscampbellfrancoiscampbell
committed
Updated documentation
1 parent d299878 commit 29fa493

File tree

2 files changed

+83
-26
lines changed

2 files changed

+83
-26
lines changed

‎META-INF/plugin.xml

+74-25
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,88 @@
1+
<!DOCTYPE idea-plugin [
2+
<!ELEMENT idea-plugin (id|name|version|vendor|description|change-notes|idea-version|depends|extensions|application-components|project-components|actions)*>
3+
<!ATTLIST idea-plugin
4+
version CDATA #REQUIRED>
5+
<!ELEMENT id (#PCDATA)>
6+
<!ELEMENT name (#PCDATA)>
7+
<!ELEMENT version (#PCDATA)>
8+
<!ELEMENT vendor (#PCDATA)>
9+
<!ATTLIST vendor
10+
email CDATA #REQUIRED
11+
url CDATA #REQUIRED>
12+
<!ELEMENT description (#PCDATA)>
13+
<!ELEMENT change-notes (#PCDATA)>
14+
<!ELEMENT idea-version (#PCDATA)>
15+
<!ATTLIST idea-version
16+
since-build CDATA #REQUIRED>
17+
<!ELEMENT depends (#PCDATA)>
18+
<!ELEMENT extensions (#PCDATA)>
19+
<!ATTLIST extensions
20+
defaultExtensionNs CDATA #REQUIRED>
21+
<!ELEMENT application-components (component)*>
22+
<!ELEMENT component (implementation-class)*>
23+
<!ELEMENT implementation-class (#PCDATA)>
24+
<!ELEMENT project-components (#PCDATA)>
25+
<!ELEMENT actions (action)*>
26+
<!ELEMENT action (add-to-group)*>
27+
<!ATTLIST action
28+
class CDATA #REQUIRED
29+
description CDATA #REQUIRED
30+
icon CDATA #REQUIRED
31+
id CDATA #REQUIRED
32+
text CDATA #REQUIRED>
33+
<!ELEMENT add-to-group (#PCDATA)>
34+
<!ATTLIST add-to-group
35+
anchor CDATA #REQUIRED
36+
group-id CDATA #REQUIRED>
37+
]>
138
<idea-plugin version="2">
239
<id>io.github.francoiscambell.clionarduinoplugin</id>
340
<name>CLion Arduino</name>
441
<version>1.0.2</version>
542
<vendor email="" url="https://github.com/francoiscampbell/CLionArduinoPlugin">Francois Campbell</vendor>
643

744
<description><![CDATA[
8-
<h1>CLion Arduino Plugin</h1>
9-
<br>
45+
<h1>CLion Arduino Plugin</h1>
46+
<br>
1047
11-
<a href="https://github.com/francoiscampbell/CLionArduinoPlugin">GitHub</a> |
12-
<a href="https://github.com/francoiscampbell/CLionArduinoPlugin/issues">Issues</a>
13-
<br>
14-
<br>
48+
<a href="https://github.com/francoiscampbell/CLionArduinoPlugin">GitHub</a> |
49+
<a href="https://github.com/francoiscampbell/CLionArduinoPlugin/issues">Issues</a>
50+
<br>
51+
<br>
1552
16-
This is a plugin to enable Arduino CMake integration into CLion. It uses the amazing <a href="https://github.com/queezythegreat/arduino-cmake">Arduino CMake</a>
17-
project from queezythegreat.
18-
<br>
19-
<br>
20-
The current features are to convert a default CLion project into an Arduino CMake one in one click, and to create new sketch files. When CLion adds the ability to hook into project creation directly, I will be able to make it selectable at project creation time, but for now, we're stuck with having to create a new CLion project and then convert it.
21-
<br>
22-
<br>
23-
Future features are to add menu option to easily change the board type, port number, etc.
24-
]]></description>
53+
This is a plugin to enable Arduino CMake integration into CLion. It uses the amazing <a
54+
href="https://github.com/queezythegreat/arduino-cmake">Arduino CMake</a>
55+
project from queezythegreat.
56+
<br>
57+
<br>
58+
The current features are to convert a default CLion project into an Arduino CMake one in one click, and to create new sketch files. When CLion adds the ability to hook into project creation directly, I will be able to make it selectable at project creation time, but for now, we're stuck with having to create a new CLion project and then convert it.
59+
<br>
60+
<br>
61+
Future features are to add menu option to easily change the board type, port number, etc.
62+
]]></description>
2563

2664
<change-notes><![CDATA[
27-
<b>1.0</b>
28-
<ul>
29-
<li>Convert a project to Arduino CMake. This replaces CMakeLists.txt with a default one, deletes the default
30-
main.cpp file, copies in the Arduino CMake toolchain files, and deletes the build direcory to start fresh</li>
31-
<li>Associates .ino and .pde files as C++ source, so you get syntax highlighting and prediction, etc.</li>
32-
<li>Create a new sketch file in any directory. If you omit the extension, it will add .ino automatically</li>
33-
<li>Adds import for Arduino.h to all newly created sketch files to enable code completion</li>
34-
<li>Compiled with Java 6 for compatibility with OS X out of the box</li>
35-
</ul>
36-
]]>
65+
<b>1.0.2</b>
66+
<ul>
67+
<li>Removed Groovy runtime, no longer necessary</li>
68+
</ul>
69+
<b>1.0.1</b>
70+
<ul>
71+
<li>Fixed organization</li>
72+
</ul>
73+
<b>1.0</b>
74+
<ul>
75+
<li>Convert a project to Arduino CMake. This replaces CMakeLists.txt with a default one, deletes the default
76+
main.cpp file, copies in the Arduino CMake toolchain files, and deletes the build direcory to start
77+
fresh
78+
</li>
79+
<li>Associates .ino and .pde files as C++ source, so you get syntax highlighting and prediction, etc.</li>
80+
<li>Create a new sketch file in any directory. If you omit the extension, it will add .ino automatically
81+
</li>
82+
<li>Adds import for Arduino.h to all newly created sketch files to enable code completion</li>
83+
<li>Compiled with Java 6 for compatibility with OS X out of the box</li>
84+
</ul>
85+
]]>
3786
</change-notes>
3887

3988
<!-- please see https://confluence.jetbrains.com/display/IDEADEV/Build+Number+Ranges for description -->

‎README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,15 @@ The current features are to convert a default CLion project into an Arduino CMak
66

77
Future features are to add menu option to easily change the board type, port number, etc.
88

9-
**Version 1.0**
9+
**1.0.2**
10+
11+
* Removed Groovy runtime, no longer necessary
12+
13+
**1.0.1**
14+
15+
* Fixed organization
16+
17+
**1.0**
1018

1119
* Convert a project to Arduino CMake. This replaces CMakeLists.txt with a default one, deletes the default main.cpp file, copies in the Arduino CMake toolchain files, and deletes the build direcory to start fresh
1220
* Associates .ino and .pde files as C++ source, so you get syntax highlighting and prediction, etc.

0 commit comments

Comments
 (0)