Skip to content

Commit e8a6b94

Browse files
committed
docreag
1 parent 8c47a35 commit e8a6b94

File tree

6 files changed

+41
-1
lines changed

6 files changed

+41
-1
lines changed

Diff for: API-doc-FORD-file.md

+33
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,36 @@ The documentation for comment markup in source code, running [FORD] and the [FOR
5555
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford#readme
5656
[FORD wiki]: https://github.com/Fortran-FOSS-Programmers/ford/wiki
5757
[FORD project file]: https://github.com/fortran-lang/stdlib/blob/master/API-doc-FORD-file.md
58+
59+
Goals and Motivation
60+
====================
61+
62+
The Fortran Standard, as published by the ISO (https://wg5-fortran.org/), does
63+
not have a Standard Library. The goal of this project is to provide a community
64+
driven and agreed upon *de facto* "standard" library for Fortran, called a
65+
Fortran Standard Library (`stdlib`). We have a rigorous process how `stdlib` is
66+
developed as documented in our [Workflow](page/contributing/Workflow.html). `stdlib` is both a
67+
specification and a reference implementation. We are cooperating with the
68+
Fortran Standards Committee (e.g., the effort
69+
[started](https://github.com/j3-fortran/fortran_proposals/issues/104) at the J3
70+
committee repository) and the plan is to continue working with the Committee in
71+
the future (such as in the step 5. in the [Workflow](page/contributing/Workflow.html) document), so
72+
that if the Committee wants to standardize some feature already available in `stdlib`, it would
73+
base it on `stdlib`'s implementation.
74+
75+
Scope
76+
=====
77+
78+
The goal of the Fortran Standard Library is to achieve the following general scope:
79+
80+
* Utilities (containers, strings, files, OS/environment integration, unit
81+
testing & assertions, logging, ...)
82+
* Algorithms (searching and sorting, merging, ...)
83+
* Mathematics (linear algebra, sparse matrices, special functions, fast Fourier
84+
transform, random numbers, statistics, ordinary differential equations,
85+
numerical integration, optimization, ...)
86+
87+
License
88+
=======
89+
90+
The `stdlib` source code and related files and documentation are distributed under the [MIT license](page/License.html).
File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: doc/contributing/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Contributing
3+
---
4+
5+
This page aims to prodive information that are useful for `stdlib` contributors.
6+
Issues can be reported on [GitHub](https://github.com/fortran-lang/stdlib/issues).
7+

Diff for: doc/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Specs, examples & user docs
2+
title: Contributing and specs
33
---
44

55
@warning

0 commit comments

Comments
 (0)