Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding some documentation for the checked languages command line options #235

Draft
wants to merge 35 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
99c3767
Initial Home page
Floriana-Cmphn Jul 26, 2018
15ba032
Updated Home (markdown)
Sep 26, 2018
4d6cb38
Updated Home (markdown)
Sep 27, 2018
93d2946
Updated Home (markdown)
Sep 27, 2018
b34c868
Updated Home (markdown)
Sep 27, 2018
d677021
Updated Home (markdown)
Sep 27, 2018
57fc554
Updated Home (markdown)
Sep 27, 2018
516ac2a
Updated Home (markdown)
Sep 27, 2018
4bbbbb4
Created Developper Guide (markdown)
Sep 27, 2018
1428ad9
Updated Developper Guide (markdown)
Sep 27, 2018
c1bd8cf
Created _Sidebar (markdown)
Sep 27, 2018
2db60ed
Updated _Sidebar (markdown)
Sep 27, 2018
c75a332
Updated _Sidebar (markdown)
Sep 27, 2018
267407c
Updated _Sidebar (markdown)
Sep 27, 2018
68b14d7
Updated Home (markdown)
begarco Sep 10, 2019
bb4e550
Updated Home (markdown)
begarco Jan 25, 2020
d1dd575
Updated _Sidebar (markdown)
begarco Jan 25, 2020
f13ee67
Updated Home (markdown)
begarco Jan 25, 2020
0fa84b6
First plan with Introduction and Limitations
begarco Jan 25, 2020
e9befcd
Add plan and introduction
begarco Jan 25, 2020
3a64ca7
Created _Footer (markdown)
begarco Jan 25, 2020
9f953e9
Updated Home (markdown)
begarco Jan 26, 2020
688abe0
Updated _Sidebar (markdown)
begarco Jan 26, 2020
efc46c0
Updated Home (markdown)
begarco Jan 26, 2020
c9b13c4
Updated Installation Manual (markdown)
begarco Jan 26, 2020
59e8a68
Updated User Manual (markdown)
begarco Feb 2, 2020
8e4dfd6
Add messages and shell rules
begarco Feb 3, 2020
ad1b02d
add fortran rules
begarco Feb 3, 2020
d07ebd9
Updated User Manual (markdown)
begarco Feb 4, 2020
96af0a0
Updated User Manual (markdown)
begarco Feb 11, 2020
d7dd7e6
End of SUM
begarco Feb 11, 2020
f991bbe
Fix typo
begarco Feb 11, 2020
23f9d7b
Updated Home (markdown)
begarco Feb 11, 2020
02dc91e
added more information about the --checked-languages option
Foadsf Apr 9, 2024
e37cb91
Merge branch 'master' of https://github.com/Foadsf/i-CodeCNES
Foadsf Apr 9, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions Developper-Guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This page contains recommandations for developpers who had like to contribute to i-Code CNES. Feel free to ask further informations [issues](https://github.com/lequal/i-CodeCNES/issues).

# Requirements
## Tools
To be able to make your own i-Code CNES Developpements, we recommend you to install
* Latest release of [Eclipse RCP](http://www.eclipse.org/downloads/packages/release/2018-09/r/eclipse-ide-rcp-and-rap-developers)
* Maven
* Java JDK <8

## Knowledge
A few Lexer and Lava knowledges are required to be able to edit or create new checkers, however this part is hugely explained in [[Checkers implementation]].


8 changes: 8 additions & 0 deletions Home.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# i-Code CNES Wiki

i-Code CNES is a static analysis tool for Fortran and Shell, it's verifying code compliancy with CNES standards (RNC).

## Documentation
* [[User Manual]]
* [[Installation Manual]]
* [Developer Guide](/lequal/icode-custom-plugin-example/wiki) (redirect to [lequal/icode-custom-plugin-example](/lequal/icode-custom-plugin-example) wiki)
91 changes: 91 additions & 0 deletions Installation-Manual.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
## Table of contents
+ [1. Introduction](#1-introduction)
+ [2. Installation guidelines](#2-installation-guidelines)
+ [2.1. Download i-Code](#21-download-i-code)
+ [2.2. Install i-Code CLI](#22-install-i-code-cli)
+ [2.3. Install i-Code IDE](#23-intall-i-code-ide)
+ [2.4. Install i-Code plugin for Eclipse](#24-install-i-code-plugin-for-eclipse)
+ [2.5. Install i-Code plugin for SonarQube](#25-install-i-code-plugin-for-sonarqube)
+ [3. References](#3-references)

## 1. Introduction

This document explains how to install i-Code CNES. Documentation on how to use i-Code is in the user manual [ [R1] ].

This tool provides four products:
+ A standalone version with GUI named **i-Code CNES IDE**
+ A command line version named **i-Code CLI** or **i-Code App**
+ An Eclipse plugin
+ A SonarQube plugin [ [R3] ]

Other products are available for developers:
+ **i-Code Core**: a library containing core features for developing new i-Code plugins, see [ [R4] ] for more information
+ **i-Code Library**: a library allowing to analyze code in your own application

## 2. Installation guidelines
### 2.1. Download i-Code

i-Code CNES products are available on the GitHub Release page of [i-CodeCNES](/lequal/i-CodeCNES) repository: [[https://github.com/lequal/i-CodeCNES/releases]].

For each release, the following products are available:
+ i-Code plugin for Eclipse
+ `fr.cnes.icode.repository-X.Y.Z-SNAPSHOT.zip`
+ i-Code CLI
+ `icode-X.Y.Z.zip`
+ i-Code IDE
+ `icode-ide.product-linux.gtk.x86.zip`
+ `icode-ide.product-linux.gtk.x86_64.zip`
+ `icode-ide.product-macosx.cocoa.x86_64.zip`
+ `icode-ide.product-win32.win32.x86.zip`
+ `icode-ide.product-win32.win32.x86_64.zip`

### 2.2. Install i-Code CLI

Download the latest i-Code CNES CLI version on [GitHub Releases page](https://github.com/lequal/i-CodeCNES/releases). Then put the archive in your chosen location.

#### On linux
```sh
unzip icode-X.Y.Z.zip
alias icode=$(pwd)/icode/icode
```

#### On Windows (PowerShell)
Extract the archive, then:
```ps
Set-Alias icode c:\path\to\icode\icode.bat
```

### 2.3. Install i-Code IDE
### 2.4. Install i-Code plugin for Eclipse

1. Download the eclipse plugin archive of the [last release](https://github.com/lequal/i-CodeCNES/releases).

1. Then, launch Eclipse and select the **Help > Install new Software**.

1. On the wizard, select **Add** and **Archive...** and select i-Code CNES archive.

1. Restart Eclipse.

### 2.5. Install i-Code plugin for SonarQube

All information about i-Code plugin for SonarQube is available on the official [project's repository](/lequal/sonar-icode-cnes-plugin).

There are two ways for installing the i-Code plugin:

+ Through the official SonarQube Marketplace
+ Manually by downloading the plugin on [its GitHub Release page](/lequal/sonar-icode-cnes-plugin/releases) and then following the installation guide in [ [R5] ]

In any case, follow instructions of official SonarQube documentation for properly install this plugin [ [R5] ].

## 3. References
[R1]: #3-references
[R2]: #3-references
[R3]: #3-references
[R4]: #3-references
[R5]: #3-references

+ [ [R1] ] [i-Code User Manual](http://www.eclipse.org/documentation/)
+ [ [R2] ] [Eclipse Documentation](http://www.eclipse.org/documentation/)
+ [ [R3] ] [SonarQube plugin for i-Code](https://github.com/lequal/sonar-icode-cnes-plugin)
+ [ [R4] ] [i-Code Developer Guide](https://github.com/lequal/icode-custom-plugin-example/wiki)
+ [ [R5] ] [Install a SonarQube plugin](https://docs.sonarqube.org/latest/setup/install-plugin/)
Loading