Skip to content

Commit

Permalink
Improve the README.md files
Browse files Browse the repository at this point in the history
The top of each file now link to the other README.md files, letting one
navigate more easily to the information desired.
  • Loading branch information
xexyl committed Nov 5, 2024
1 parent 3f32660 commit 736dd87
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,30 @@ Contest](https://www.ioccc.org)), originally in the [mkiocccentry
repo](https://github.com/ioccc-src/mkiocccentry), but we provide it here so that
anyone can use it.

As a stand-alone tool, `jparse` itself is less useful, except for validating
JSON documents (as a file on disk or stdin or even over a network, or as a
string), and as a simple example that uses the library. On the other hand, the
`jparse` library is much more useful because you can integrate it into your own
applications and work with the parsed tree(s).
This document discusses the dependencies (and how to obtain, compile and install
them), how to compile and install (as well as uninstall, should you need to deobfuscate
your system :-) ) the `jparse` tools and library, how to report bugs and a brief
history on `jparse` as a whole.

For information on our utilities, including `jparse(1)` but also tools to
encode/decode JSON decoded/encoded strings, we refer you to the
encode/decode JSON decoded/encoded strings (others of different applications are
in the pipeline as well), we refer you to the
[jparse_util_README.md](https://github.com/xexyl/jparse/blob/master/jparse_util_README.md)
file.

For information on using the `jparse` library, we refer you to the file
As a stand-alone tool, `jparse` itself is less useful, except for validating
JSON documents (as a file on disk or stdin or even over a network, or as a
string), and as a simple example that uses the library.

The `jparse` library is much more useful for C programmers because you can
integrate it into your own applications and work with the parsed tree(s). For
information on using the `jparse` library, we refer you to the file
[jparse_library_README.md](https://github.com/xexyl/jparse/blob/master/jparse_library_README.md).

We also do recommend that you read the
[json_README.md](https://github.com/xexyl/jparse/blob/master/json_README.md)
document to better understand the JSON terms used in this repo.

This document discusses the dependencies (and how to obtain, compile and install
them), how to compile and install (as well as uninstall, should you need to deobfuscate
your system :-) ) the tools and library, in order to use it, how to report bugs
and a brief history on `jparse` as a whole.

For information on our testing suite, we refer you to the
[test_jparse/README.md](https://github.com/xexyl/jparse/blob/master/test_jparse/README.md),
but this is mostly for repo maintainers or those who are interested in how we
Expand Down
12 changes: 12 additions & 0 deletions jparse_library_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ how to use it in a C application that needs to parse and process valid JSON
documents, whether in a file (on disk or stdin, or even over a network) or a
string.

For information on the `jparse` repo, see the [jparse repo
README.md](https://github.com/xexyl/jparse/blob/master/README.md).

For information on the `jparse` utilities see
[jparse_util_README.md](https://github.com/xexyl/jparse/blob/master/jparse_util_README.md).

For information on the testing suite see
[test_jparse/README.md](https://github.com/xexyl/jparse/blob/master/test_jparse/README.md).

We also do recommend that you read the
[json_README.md](https://github.com/xexyl/jparse/blob/master/json_README.md)
document to better understand the JSON terms used in this repo.

# Table of Contents

Expand Down
16 changes: 16 additions & 0 deletions jparse_util_README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Command line utilities that parse, read and process JSON in different ways

We provide a number of utilities that work with JSON, which we describe below.
Others are in the pipeline and when they are developed this file will document
them as well. These utilities are described below.

If you want more information on the `jparse` repo, see the [jparse repo
README.md](https://github.com/xexyl/jparse/blob/master/README.md).

For information on the `jparse` library, see
[jparse_library_README.md](https://github.com/xexyl/jparse/blob/master/jparse_library_README.md).

For information on the testing suite see
[test_jparse/README.md](https://github.com/xexyl/jparse/blob/master/test_jparse/README.md).

We also do recommend that you read the
[json_README.md](https://github.com/xexyl/jparse/blob/master/json_README.md)
document to better understand the JSON terms used in this repo.

# Table of Contents

Expand Down
15 changes: 15 additions & 0 deletions test_jparse/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ Here we briefly describe for you our testing suite, for those who are
interested, though some of it is only relevant to repo maintainers (that is put
at the end of the file for that reason).

If you are looking for information on the `jparse` repo, see the [jparse repo
README.md](https://github.com/xexyl/jparse/blob/master/README.md).

For information on the `jparse` utilities see
[jparse_util_README.md](https://github.com/xexyl/jparse/blob/master/jparse_util_README.md).

For information on the `jparse` library, see
[jparse_library_README.md](https://github.com/xexyl/jparse/blob/master/jparse_library_README.md).

We also do recommend that you read the
[json_README.md](https://github.com/xexyl/jparse/blob/master/json_README.md)
document to better understand the JSON terms used in this repo.



# [test_jparse](https://github.com/xexyl/jparse/tree/master/test_jparse)

In this directory we have a [subdirectory with test JSON
Expand Down

0 comments on commit 736dd87

Please sign in to comment.