README.md 2.75 KB
Newer Older
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
1
2
# Google FlatBuffers

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
3
4
5
6
7
<!-- badges: start -->
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Twitter](https://img.shields.io/twitter/follow/Icy_BioImaging?style=social)](https://twitter.com/Icy_BioImaging)
[![Image.sc forum](https://img.shields.io/badge/discourse-forum-brightgreen.svg?style=flat)](https://forum.image.sc/tag/icy)
<!-- badges: end -->
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
8

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
9
10
This is the repository for the source code of *Google Gson*, 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.     
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
11
12


Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
13
## Plugin description
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
14

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
15
16
<!-- Short description of goals of package, with descriptive links to the documentation website --> 
Google FlatBuffers library for Icy.
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
17

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
18
https://github.com/google/flatbuffers
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
19
20


Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
21
## Installation instructions
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
22

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
23
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/).      
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
24

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
25
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).      
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
26

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
27
<!--  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).  -->
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
28
29


Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
30
## Main functions and usage
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
31

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
32
<!-- 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 -->
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
33

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
34
Classname: `plugins.stef.library.google.GoogleFlatBuffersPlugin`
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
35
36
37



Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
38
## Citation 
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
39

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
40
Please cite this plugins as follows:          
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
41
42


Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
43
44
45
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    
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
46
47
48



Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
49
## Author(s)      
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
50

Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
51
Stephane Dallongeville
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
52
53


Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
54
## Additional information
Stéphane  DALLONGEVILLE's avatar
Stéphane DALLONGEVILLE committed
55