diff --git a/README.md b/README.md index 8fe54fb6fde46552a58ef0e0c6ff7d04452ad4a9..87836bb7631ea95909356f4d7632fae32e684b85 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,68 @@ +# RSyntaxTextArea for Icy + +<!-- badges: start --> +[](https://www.gnu.org/licenses/gpl-3.0) +[](https://twitter.com/Icy_BioImaging) +[](https://forum.image.sc/tag/icy) +<!-- badges: end --> + +This is the repository for the source code of *RSyntaxTextArea for Icy*, a plugin for the [bioimage analysis software Icy](http://icy.bioimageanalysis.org/), which was developed by members or former members of the [Biological Image Analysis unit at Institut Pasteur](https://research.pasteur.fr/en/team/bioimage-analysis/). This plugin is licensed under GPL3 license. +Icy is developed and maintained by [Biological Image Analysis unit at Institut Pasteur](https://research.pasteur.fr/en/team/bioimage-analysis/). The [source code of Icy](https://gitlab.pasteur.fr/bia/icy) is also licensed under a GPL3 license. + + + +## Plugin description + +<!-- Short description of goals of package, with descriptive links to the documentation website --> + +This plugin provides a color highlighting on text. Based on RSyntaxTextArea library of Fifesoft. +A more detailed user documentation can be found on the RSyntaxTextArea for Icy documentation page on the Icy website: http://icy.bioimageanalysis.org/plugin/syntax-highlighting/ + + +## Installation instructions + +For end-users, refer to the documentation on the Icy website on [how to install an Icy plugin](http://icy.bioimageanalysis.org/tutorial/how-to-install-an-icy-plugin/). + +For developers, see our [Contributing guidelines](https://gitlab.pasteur.fr/bia/icy/-/blob/master/CONTRIBUTING.md) and [Code of Conduct](https://gitlab.pasteur.fr/bia/icy/-/blob/master/CODE-OF-CONDUCT.md). + +<!-- Here we should have some explanations on how to fork this repo (for an example see https://gitlab.pasteur.fr/bia/wellPlateReader). Add any info related to Maven etc. How the project is build (for an example see https://gitlab.pasteur.fr/bia/wellPlateReader). Any additional setup required (authentication tokens, etc). --> + + +## Main functions and usage + +<!-- list main functions, explain architecture, classname, give info on how to get started with the plugin. If applicable, how the package compares to other similar packages and/or how it relates to other packages --> + +Classname: `plugins.tprovoost.rsyntaxtextarea.RSyntaxTextAreaPlugin` + + + +## Citation + +Please cite this plugins as follows: + + +Please also cite the Icy software and mention the version of Icy you used (bottom right corner of the GUI or first lines of the Output tab): +de Chaumont, F. et al. (2012) Icy: an open bioimage informatics platform for extended reproducible research, [Nature Methods](https://www.nature.com/articles/nmeth.2075), 9, pp. 690-696 +http://icy.bioimageanalysis.org + + + +## Author(s) + +Thomas Provoost, Timothée Lecomte, Stephane Dallongeville + + +## Additional information + + + + + + RSyntaxTextArea is a customizable, syntax highlighting text component for Java Swing applications. Out of the box, it supports syntax highlighting for over 30 programming languages, code folding, search and replace, and has add-on libraries for code completion and spell checking. Syntax highlighting for additional languages [can be added](http://fifesoft.com/rsyntaxtextarea/doc/) via tools such as [JFlex](http://jflex.de). RSyntaxTextArea is available under a [modified BSD license](https://github.com/bobbylight/RSyntaxTextArea/blob/master/distfiles/RSyntaxTextArea.License.txt). For more information, visit [http://fifesoft.com/rsyntaxtextarea](http://fifesoft.com/rsyntaxtextarea). -# Example Usage - RSyntaxTextArea is simply a subclass of JTextComponent, so it can be dropped into any Swing application with ease. ```java @@ -42,7 +101,7 @@ public class TextEditorDemo extends JFrame { } ``` -# Sister Projects + Sister Projects RSyntaxTextArea provides syntax highlighting, code folding, and many other features out-of-the-box, but when building a code editor you often want to go further. Below is a list of small add-on libraries that add more complex functionality: @@ -51,7 +110,7 @@ RSyntaxTextArea provides syntax highlighting, code folding, and many other featu * [SpellChecker](https://github.com/bobbylight/SpellChecker) - Adds squiggle-underline spell checking to RSyntaxTextArea. * [RSTAUI](https://github.com/bobbylight/RSTAUI) - Common dialogs needed by text editing applications: Find, Replace, Go to Line, File Properties. -# Getting Help + Getting Help * Add an issue on GitHub * Ask in the [project forum](http://fifesoft.com/forum/)