Skip to content

Commit 48f0e05

Browse files
committed
Small tweaks
- Update CMake example to have correct patch number in version - Removed images from toc entries
1 parent ee21405 commit 48f0e05

File tree

1 file changed

+27
-15
lines changed

1 file changed

+27
-15
lines changed

README.md

Lines changed: 27 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,19 @@ A Fortran 2008 JSON API
66
<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc/generate-toc again -->
77
**Table of Contents**
88

9-
- [json-fortran [![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases/latest)](#json-fortran-github-releasehttpsimgshieldsiogithubreleasejacobwilliamsjson-fortransvgstyleplastichttpsgithubcomjacobwilliamsjson-fortranreleaseslatest)
10-
- [Status](#status)
11-
- [Brief description](#brief-description)
12-
- [Download [![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases)](#download-github-releasehttpsimgshieldsiogithubreleasejacobwilliamsjson-fortransvgstyleplastichttpsgithubcomjacobwilliamsjson-fortranreleases)
13-
- [Building the library](#building-the-library)
14-
- [Reading JSON from a file](#reading-json-from-a-file)
15-
- [Reading JSON from a string](#reading-json-from-a-string)
16-
- [Modifying variables in a JSON file](#modifying-variables-in-a-json-file)
17-
- [Writing a JSON file](#writing-a-json-file)
18-
- [Building a JSON file from scratch](#building-a-json-file-from-scratch)
19-
- [Documentation](#documentation)
20-
- [Contributing [![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](CONTRIBUTING.md)](#contributing-ready-in-backloghttpsbadgewaffleiojacobwilliamsjson-fortranpnglabelreadytitlereadycontributingmd)
21-
- [License](#license)
22-
- [Miscellaneous](#miscellaneous)
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)
2322

2423
<!-- markdown-toc end -->
2524

@@ -34,17 +33,20 @@ Status
3433
[![In Progress](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=In%20Progress&title=In%20Progress)](https://waffle.io/jacobwilliams/json-fortran)
3534
[![Needs Review](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Needs%20Review&title=Needs%20Review)](https://waffle.io/jacobwilliams/json-fortran)
3635

36+
[top](#json-fortran-)
3737
Brief description
3838
---------------
3939

4040
A user-friendly and object-oriented API for reading and writing JSON files, written in
4141
modern Fortran. The source code is a single Fortran module file ([json_module.F90](https://github.com/jacobwilliams/json-fortran/blob/master/src/json_module.F90)).
4242

43+
[top](#json-fortran-)
4344
Download [![GitHub release](https://img.shields.io/github/release/jacobwilliams/json-fortran.svg?style=plastic)](https://github.com/jacobwilliams/json-fortran/releases)
4445
--------------------
4546

4647
Download the official versioned releases [here](https://github.com/jacobwilliams/json-fortran/releases/latest). Or, get the latest development code from the master branch [here](https://github.com/jacobwilliams/json-fortran.git).
4748

49+
[top](#json-fortran-)
4850
Building the library
4951
--------------------
5052

@@ -86,7 +88,7 @@ cmake_minimum_required ( VERSION 2.8.8 FATAL_ERROR )
8688
enable_language ( Fortran )
8789
project ( jf_test NONE )
8890
89-
find_package ( jsonfortran-${CMAKE_Fortran_COMPILER_ID} 4.1.0 REQUIRED )
91+
find_package ( jsonfortran-${CMAKE_Fortran_COMPILER_ID} 4.1.1 REQUIRED )
9092
include_directories ( "${jsonfortran_INCLUDE_DIRS}" )
9193
9294
file ( GLOB JF_TEST_SRCS "src/tests/jf_test_*.f90" )
@@ -99,6 +101,7 @@ foreach ( UNIT_TEST ${JF_TEST_SRCS} )
99101
endforeach()
100102
```
101103

104+
[top](#json-fortran-)
102105
Reading JSON from a file
103106
---------------
104107

@@ -140,6 +143,7 @@ for more examples. The source files may be found in `src/tests/`.
140143
end program example1
141144
```
142145

146+
[top](#json-fortran-)
143147
Reading JSON from a string
144148
---------------
145149
JSON can also be read directly from a character string like so:
@@ -159,6 +163,7 @@ After reading a JSON file, if you want to change the values of some of the varia
159163
call json%update('version.patch',0,found) !change patch to 0
160164
```
161165

166+
[top](#json-fortran-)
162167
Writing a JSON file
163168
---------------
164169

@@ -169,6 +174,7 @@ To print the JSON file (either to a file or the console), the `print_file` metho
169174
call json%print_file(iunit) !prints to the file connected to iunit
170175
```
171176

177+
[top](#json-fortran-)
172178
Building a JSON file from scratch
173179
---------------
174180

@@ -244,19 +250,23 @@ The code above produces the file:
244250
}
245251
```
246252

253+
[top](#json-fortran-)
247254
Documentation
248255
--------------
249256

250257
The API documentation for the latest release version can be found [here](http://jacobwilliams.github.io/json-fortran). The documentation can also be generated by processing the source files with [RoboDoc](http://rfsber.home.xs4all.nl/Robo/). Note that both the shell script, CMake, and SCons will also generate these files automatically in the documentation folder, assuming you have RoboDoc installed.
251258

259+
[top](#json-fortran-)
252260
Contributing [![Ready in backlog](https://badge.waffle.io/jacobwilliams/json-fortran.png?label=Ready&title=Ready)](CONTRIBUTING.md)
253261
------------
254262
Want to help? Take a quick look at our [contributing guidelines](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).
255263

264+
[top](#json-fortran-)
256265
License
257266
--------
258267
The json-fortran source code and related files and documentation are distributed under a permissive free software license (BSD-style). See the [LICENSE](https://raw.githubusercontent.com/jacobwilliams/json-fortran/master/LICENSE) file for more details.
259268

269+
[top](#json-fortran-)
260270
Miscellaneous
261271
---------------
262272

@@ -265,3 +275,5 @@ Miscellaneous
265275
* [json-fortran on Travis CI](https://travis-ci.org/jacobwilliams/json-fortran)
266276
* [json-fortran on Waffle.IO](https://waffle.io/jacobwilliams/json-fortran)
267277
* [json-fortran on Coveralls.IO](https://coveralls.io/r/jacobwilliams/json-fortran)
278+
279+
[top](#json-fortran-)

0 commit comments

Comments
 (0)