|
173
|
1 # Flang
|
|
|
2
|
|
|
3 Flang is a ground-up implementation of a Fortran front end written in modern
|
|
|
4 C++. It started off as the f18 project (https://github.com/flang-compiler/f18)
|
|
|
5 with an aim to replace the previous flang project
|
|
|
6 (https://github.com/flang-compiler/flang) and address its various deficiencies.
|
|
|
7 F18 was subsequently accepted into the LLVM project and rechristened as Flang.
|
|
|
8
|
|
252
|
9 Please note that flang is not ready yet for production usage.
|
|
|
10
|
|
173
|
11 ## Getting Started
|
|
|
12
|
|
221
|
13 Read more about flang in the [docs directory](docs).
|
|
|
14 Start with the [compiler overview](docs/Overview.md).
|
|
173
|
15
|
|
|
16 To better understand Fortran as a language
|
|
|
17 and the specific grammar accepted by flang,
|
|
221
|
18 read [Fortran For C Programmers](docs/FortranForCProgrammers.md)
|
|
173
|
19 and
|
|
221
|
20 flang's specifications of the [Fortran grammar](docs/f2018-grammar.md)
|
|
173
|
21 and
|
|
221
|
22 the [OpenMP grammar](docs/OpenMP-4.5-grammar.md).
|
|
173
|
23
|
|
|
24 Treatment of language extensions is covered
|
|
221
|
25 in [this document](docs/Extensions.md).
|
|
173
|
26
|
|
|
27 To understand the compilers handling of intrinsics,
|
|
221
|
28 see the [discussion of intrinsics](docs/Intrinsics.md).
|
|
173
|
29
|
|
|
30 To understand how a flang program communicates with libraries at runtime,
|
|
221
|
31 see the discussion of [runtime descriptors](docs/RuntimeDescriptor.md).
|
|
173
|
32
|
|
|
33 If you're interested in contributing to the compiler,
|
|
221
|
34 read the [style guide](docs/C++style.md)
|
|
173
|
35 and
|
|
221
|
36 also review [how flang uses modern C++ features](docs/C++17.md).
|
|
|
37
|
|
236
|
38 If you are interested in writing new documentation, follow
|
|
|
39 [LLVM's Markdown style guide](https://github.com/llvm/llvm-project/blob/main/llvm/docs/MarkdownQuickstartTemplate.md).
|
|
|
40
|
|
252
|
41 Consult the [Getting Started with Flang](docs/GettingStarted.md)
|
|
|
42 for information on building and running flang.
|
