From e1fac9d5349e431be9cbebe8f76abdc0e5171022 Mon Sep 17 00:00:00 2001 From: Carlo Sciolla Date: Sat, 21 Nov 2015 12:04:17 +0100 Subject: [PATCH] Moved some docs to the wiki, reduced the README content --- .idea/encodings.xml | 4 +++- README.org | 33 +++++++++++---------------------- 2 files changed, 14 insertions(+), 23 deletions(-) diff --git a/.idea/encodings.xml b/.idea/encodings.xml index d821048..f758959 100644 --- a/.idea/encodings.xml +++ b/.idea/encodings.xml @@ -1,4 +1,6 @@ - + + + \ No newline at end of file diff --git a/README.org b/README.org index 4db6acf..f55f667 100644 --- a/README.org +++ b/README.org @@ -4,13 +4,11 @@ * Introduction -This plugin provides basic editing support for [[http://orgmode.org/][org-mode]] files in IntelliJ. +This plugin provides basic editing support for [[http://orgmode.org/][org-mode]] files in IntelliJ. At the moment, only support for syntax highlight of comments and outlines is provided. - At the moment, only support for syntax highlight of comments and outlines is provided. +_DISCLAIMER_: *org4idea* is still in its /inception / pre-alpha / here-be-dragons phase/. Use at your own risk. -*org4idea* is still in its /inception / pre-alpha / here-be-dragons phase/. Use at your own risk. - -* Pending basic features +* Status and planned features ** Basic Editing These feature only requires some Intellij customisation of the plugin, and basic lexing rules @@ -28,22 +26,13 @@ These feature only requires some Intellij customisation of the plugin, and basic - [ ] tagging ** Miscellaneous -- create new org file -- capture like actions -- Link support -- Export and html preview (relying on a background emacs) -- the one you might suggest or implement -- Line marker - -* Building from source -- setup :: Open the module setting and select /Intellij IDEA Plugin SDK/ as project SDK -- run/test :: Use /Run Configuration/ to run the plugin and tests - # when there will be some -- release :: /Build > Prepare plugin for deployment/ to generate the release package. -# inspiration from idea-markdown -Ensure that *Plugin DevKit* is activated (=Settings | Plugins=). You might also need the =JFlex= support if you are considering tweaking the lexing rules - -# §TODO: see https://github.com/rholder/gradle-view to have inspired gradle build +- [ ] create new org file +- [ ] capture like actions +- [ ] Link support +- [ ] Export and html preview (relying on a background emacs) +- [ ] the one you might [[https://github.com/skuro/org4idea/issues][suggest or implement]] +- [ ] Line marker + * Credits - Project author :: [[http://skuro.tk][Carlo Sciolla]] @@ -53,4 +42,4 @@ Ensure that *Plugin DevKit* is activated (=Settings | Plugins=). You might also * License -All files in this repository except OrgMode logos are released under the [[https://github.com/skuro/org4idea/blob/master/LICENSE.txt][MIT license]]. +All files in this repository except OrgMode logos are released under the [[LICENSE.txt][MIT License]].