Skip to content

Commit 159c089

Browse files
authored
Update README.md
1 parent ccafd9d commit 159c089

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,25 @@ For more details see the following:
1111

1212
* Tutorials and template project: https://github.com/sv-giampa/JointyC-Tutorials
1313

14-
Follow a fast presentation of the library and more detailed introduction.
14+
## Introduction
15+
16+
JointyC is a Java library to write compilers. Its main target is to move
17+
the attention of the developer from parsing to the semantic analysis and,
18+
at the same time, to simplify this part of work.
19+
The library is divided in two main modules:
20+
21+
1. The analysis framework
22+
23+
2. The JointyC Definition Language Compiler (JDLC)
24+
25+
The first module exposes a framework to face up to the analysis work,
26+
composed by lexical, syntactic and semantic analysis.
27+
The second module is based on the first one and provides a compiler for
28+
the JointyC Definition Language (JDL), used to define recursive-descent
29+
parsers for context-free languages, that can be adorned with contextual
30+
information during semantic analysis.
31+
32+
Follows a fast presentation of the library and more detailed introduction.
1533

1634
# A very fast presentation of the idea
1735
After this very short description, really few things will be clear, but probably the power of JointyC will be one of these.
@@ -72,26 +90,7 @@ And now, please continue reading.
7290
# Objectives of the library
7391
This is a more detailed presentation of the library.
7492

75-
## 1. Introduction.
76-
77-
JointyC is a Java library to write compilers. Its main target is to move
78-
the attention of the developer from parsing to the semantic analysis and,
79-
at the same time, to simplify this part of work.
80-
The library is divided in two main modules:
81-
82-
1. The analysis framework
83-
84-
2. The JointyC Definition Language Compiler (JDLC)
85-
86-
The first module exposes a framework to face up to the analysis work,
87-
composed by lexical, syntactic and semantic analysis.
88-
The second module is based on the first one and provides a compiler for
89-
the JointyC Definition Language (JDL), used to define recursive-descent
90-
parsers for context-free languages, that can be adorned with contextual
91-
information during semantic analysis.
92-
93-
94-
## 2. Software Engineering in the scope.
93+
## Software Engineering in the scope
9594

9695
As anticipated, the most important target of JointyC is to simplify the
9796
work of the developers, not only during construction, but also during
@@ -117,7 +116,7 @@ More details over this process and other functionalities are described
117116
in the documentation and in the wiki.
118117

119118

120-
## 3. The analysis framework.
119+
## The analysis framework
121120

122121
The analysis framework is divided in three sub-modules: lexer, parser and
123122
semantic analyzer. The framework provides all the interfaces that define
@@ -136,7 +135,7 @@ necessarily use the JDL Compiler. Moreover, it is recommended to use the
136135
JDL Compiler, to obtain a higher maintenance and readability performance.
137136

138137

139-
## 4. The JointyC Definition Language Compiler (JDL Compiler).
138+
## The JointyC Definition Language Compiler (JDL Compiler)
140139

141140
By using the JDL Compiler it is possible to define and compile a parser
142141
and the associated lexer at run-time. The objective is to have a double
@@ -155,7 +154,7 @@ allows to keep the grammar and the access to the syntax tree as generic
155154
as possible.
156155

157156

158-
## 5. Conclusions and recommendations.
157+
## Conclusions and recommendations
159158

160159
For the explained reasons, the JointyC library could be one of the best
161160
choices for designing a language for some project. It is emphasized

0 commit comments

Comments
 (0)