Skip to content

Commit a8f40ae

Browse files
committed
Fix TOC and some minor layout/wording issues
1 parent b16fa00 commit a8f40ae

File tree

2 files changed

+43
-36
lines changed

2 files changed

+43
-36
lines changed

CHANGELOG.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Change Log
1+
## Change Log
22

33
**Table of Contents**
44

@@ -12,9 +12,9 @@
1212
- [2.0.0 (2014-12-27)](#200-2014-12-27)
1313
- [1.0.0 (2014-06-23)](#100-2014-06-23)
1414

15-
## [Unreleased](https://github.com/jacobwilliams/json-fortran/tree/HEAD)
15+
### [Unreleased](https://github.com/jacobwilliams/json-fortran/tree/HEAD)
1616

17-
[Full Changelog](https://github.com/jacobwilliams/json-fortran/compare/4.1.1...HEAD)
17+
[Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/4.1.1...HEAD)
1818

1919
**Enhancements**
2020
- Removed official SCons support to facilitate faster development
@@ -75,9 +75,9 @@
7575
([zbeekman](https://github.com/zbeekman))
7676

7777

78-
## [4.1.1](https://github.com/jacobwilliams/json-fortran/tree/4.1.1) (2015-05-27)
78+
### [4.1.1](https://github.com/jacobwilliams/json-fortran/tree/4.1.1) (2015-05-27)
7979

80-
[Full Changelog](https://github.com/jacobwilliams/json-fortran/compare/4.1.0...4.1.1)
80+
[Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/4.1.0...4.1.1)
8181
or [Download v4.1.1](https://github.com/jacobwilliams/json-fortran/releases/tag/4.1.1)
8282

8383
**Enhancements**
@@ -111,7 +111,7 @@ or [Download v4.1.1](https://github.com/jacobwilliams/json-fortran/releases/tag/
111111

112112

113113

114-
## [4.1.0](https://github.com/jacobwilliams/json-fortran/tree/4.1.0) (2015-05-05)
114+
### [4.1.0](https://github.com/jacobwilliams/json-fortran/tree/4.1.0) (2015-05-05)
115115

116116
[Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/4.0.0...4.1.0)
117117
or [Download v4.1.0](https://github.com/jacobwilliams/json-fortran/releases/tag/4.1.0)
@@ -132,7 +132,7 @@ or [Download v4.1.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
132132

133133

134134

135-
## [4.0.0](https://github.com/jacobwilliams/json-fortran/tree/4.0.0) (2015-03-16)
135+
### [4.0.0](https://github.com/jacobwilliams/json-fortran/tree/4.0.0) (2015-03-16)
136136

137137
[Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/3.1.0...4.0.0)
138138
or [Download v4.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/4.0.0)
@@ -203,7 +203,7 @@ or [Download v4.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
203203

204204

205205

206-
## [3.1.0](https://github.com/jacobwilliams/json-fortran/tree/3.1.0) (2015-02-28)
206+
### [3.1.0](https://github.com/jacobwilliams/json-fortran/tree/3.1.0) (2015-02-28)
207207

208208
[Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/3.0.0...3.1.0)
209209
or [Download v3.1.0](https://github.com/jacobwilliams/json-fortran/releases/tag/3.1.0)
@@ -275,7 +275,7 @@ or [Download v3.1.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
275275

276276

277277

278-
## [3.0.0](https://github.com/jacobwilliams/json-fortran/tree/3.0.0) (2015-01-18)
278+
### [3.0.0](https://github.com/jacobwilliams/json-fortran/tree/3.0.0) (2015-01-18)
279279

280280
[Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/2.0.0...3.0.0)
281281
or [Download v3.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/3.0.0)
@@ -310,7 +310,7 @@ or [Download v3.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
310310

311311

312312

313-
## [2.0.0](https://github.com/jacobwilliams/json-fortran/tree/2.0.0) (2014-12-27)
313+
### [2.0.0](https://github.com/jacobwilliams/json-fortran/tree/2.0.0) (2014-12-27)
314314

315315
[Complete Changeset](https://github.com/jacobwilliams/json-fortran/compare/1.0.0...2.0.0)
316316
or [Download v2.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/2.0.0)
@@ -327,7 +327,7 @@ or [Download v2.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/
327327

328328

329329

330-
## [1.0.0](https://github.com/jacobwilliams/json-fortran/tree/1.0.0) (2014-06-23)
330+
### [1.0.0](https://github.com/jacobwilliams/json-fortran/tree/1.0.0) (2014-06-23)
331331

332332
[Download v1.0.0](https://github.com/jacobwilliams/json-fortran/releases/tag/1.0.0)
333333

README.md

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
1-
json-fortran [![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases/latest)
1+
json-fortran
22
============
33

4+
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases/latest)
45
A Fortran 2008 JSON API
56

67
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
78
**Table of Contents**
89

9-
- [Status](#status)
10-
- [Brief description](#brief-description)
11-
- [Download](#download)
12-
- [Building the library](#building-the-library)
13-
- [Reading JSON from a file](#reading-json-from-a-file)
14-
- [Reading JSON from a string](#reading-json-from-a-string)
15-
- [Modifying variables in a JSON file](#modifying-variables-in-a-json-file)
16-
- [Writing a JSON file](#writing-a-json-file)
17-
- [Building a JSON file from scratch](#building-a-json-file-from-scratch)
18-
- [Documentation](#documentation)
19-
- [Contributing](#contributing)
20-
- [License](#license)
21-
- [Miscellaneous](#miscellaneous)
10+
- [json-fortran](#json-fortran)
11+
- [Status](#status)
12+
- [Brief description](#brief-description)
13+
- [Download](#download)
14+
- [Building the library](#building-the-library)
15+
- [Exapmle Usage](#exapmle-usage)
16+
- [Reading JSON from a file](#reading-json-from-a-file)
17+
- [Reading JSON from a string](#reading-json-from-a-string)
18+
- [Modifying variables in a JSON file](#modifying-variables-in-a-json-file)
19+
- [Writing a JSON file](#writing-a-json-file)
20+
- [Building a JSON file from scratch](#building-a-json-file-from-scratch)
21+
- [Documentation](#documentation)
22+
- [Contributing](#contributing)
23+
- [License](#license)
24+
- [Miscellaneous](#miscellaneous)
2225

2326
<!-- markdown-toc end -->
2427

@@ -47,9 +50,11 @@ modern Fortran. The source code is a single Fortran module file ([json_module.F
4750

4851
[top](#json-fortran)
4952

50-
Download [![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases)
53+
Download
5154
--------------------
5255

56+
[![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases)
57+
5358
Download the official versioned releases
5459
[here](https://github.com/jacobwilliams/json-fortran/releases/latest).
5560
Or, get the latest development code from the master branch
@@ -130,8 +135,11 @@ endforeach()
130135

131136
[top](#json-fortran)
132137

133-
Reading JSON from a file
138+
Exapmle Usage
134139
---------------
140+
In this section the basic functionality of the JSON-Fortran library is illustrated.
141+
142+
### Reading JSON from a file
135143

136144
Reading a JSON file and getting data from it is fairly
137145
straightforward using the `json_file` class. Here is an example. See unit tests 1 and 3-6
@@ -173,8 +181,7 @@ for more examples. The source files may be found in `src/tests/`.
173181

174182
[top](#json-fortran)
175183

176-
Reading JSON from a string
177-
---------------
184+
### Reading JSON from a string
178185

179186
JSON can also be read directly from a character string like so:
180187
```fortran
@@ -183,8 +190,7 @@ JSON can also be read directly from a character string like so:
183190

184191
[top](#json-fortran)
185192

186-
Modifying variables in a JSON file
187-
---------------
193+
### Modifying variables in a JSON file
188194

189195
After reading a JSON file, if you want to change the values of some of the variables, you can use the `update` method. For the example above:
190196

@@ -197,8 +203,7 @@ After reading a JSON file, if you want to change the values of some of the varia
197203

198204
[top](#json-fortran)
199205

200-
Writing a JSON file
201-
---------------
206+
### Writing a JSON file
202207

203208
To print the JSON file (either to a file or the console), the `print_file` method can be used. For the above example:
204209

@@ -209,8 +214,7 @@ To print the JSON file (either to a file or the console), the `print_file` metho
209214

210215
[top](#json-fortran)
211216

212-
Building a JSON file from scratch
213-
---------------
217+
### Building a JSON file from scratch
214218

215219
Constructing a JSON file element by element is slightly more complicated and involves the use
216220
of `json_value` pointers. For more examples see unit tests 2, 4 and 7 in `src/tests/`.
@@ -297,8 +301,11 @@ shell script and CMake will also generate these files automatically in the docum
297301

298302
[top](#json-fortran)
299303

300-
Contributing [![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](https://github.com/jacobwilliams/json-fortran/blob/master/CONTRIBUTING.md)
304+
Contributing
301305
------------
306+
307+
[![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](https://github.com/jacobwilliams/json-fortran/blob/master/CONTRIBUTING.md)
308+
302309
Want to help? Take a quick look at our [contributing guidelines](https://github.com/jacobwilliams/json-fortran/blob/master/CONTRIBUTING.md) then claim something in [the "ready" column on our Waffle.io](https://waffle.io/jacobwilliams/json-fortran) and [Fork. Commit. Pull request.](https://help.github.com/articles/fork-a-repo)
303310

304311
[top](#json-fortran)

0 commit comments

Comments
 (0)