Skip to content

Commit

Permalink
Moved some docs to the wiki, reduced the README content
Browse files Browse the repository at this point in the history
  • Loading branch information
@skuro
skuro committed Nov 21, 2015
1 parent 877d287 commit e1fac9d
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 23 deletions.
4 changes: 3 additions & 1 deletion .idea/encodings.xml
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

33 changes: 11 additions & 22 deletions README.org
View file
Expand Up @@ -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

Expand All @@ -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]]
Expand All @@ -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]].

3 comments on commit e1fac9d

@AdrieanKhisbe
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good Idea! :)
Suits better in a wiki.
Gonna add the notes I had on unversionned files

@skuro
Copy link
Owner Author

@skuro skuro commented on e1fac9d Nov 21, 2015 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AdrieanKhisbe
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was thinking about this, but not on short term.
I think that to do this, we should swicth to use Grammar Kit.: https://github.com/JetBrains/Grammar-Kit

But switching to this, and setting the base so we can easily hack around is crucial and not that easy I would say. (help would be appreciated if someone experienced read this :D)

I had collected some links few month ago, but don't remember finding a proper getting started guide.

Please sign in to comment.