mirror of
https://github.com/nlohmann/json.git
synced 2026-09-30 19:50:34 +00:00
Fix stale install/usage instructions in the vendored amalgamate README
tools/amalgamate/README.md is the unmodified upstream text and no longer matches how the tool is used here: - It named a Bitbucket origin that no longer exists; CHANGES.md already tracks the GitHub mirror commit this copy is based on. - It asked for Python 2.7, but CI and the Makefile run the script with python3. - It told readers to run ./test.sh (not vendored) and install to /usr/local/bin; in this repository the tool runs through `make amalgamate`. - Its usage synopsis showed `-v` taking no argument, but the script's own argparser requires `choices=["yes", "no"]`, so that form fails with "argument -v/--verbose: expected one argument". The Makefile calls it as `--verbose=yes`. - It pointed at test/source.c.json and test/include.h.json, which are not vendored; the configs actually used are config_json.json and config_json_fwd.json. Rewrote only the Installing and Using sections to match; left the "Here be dragons" caveats and the rest of the vendored code untouched to avoid diverging further from upstream. Overlaps #5615, which edits amalgamate.py, this README and CHANGES.md. #5717 item 6 Signed-off-by: Niels Lohmann <mail@nlohmann.me>
This commit is contained in:
+15
-11
@@ -1,8 +1,8 @@
|
||||
# amalgamate.py - Amalgamate C source and header files
|
||||
|
||||
Origin: https://bitbucket.org/erikedlund/amalgamate
|
||||
|
||||
Mirror: https://github.com/edlund/amalgamate
|
||||
Origin: https://github.com/edlund/amalgamate (formerly hosted at
|
||||
https://bitbucket.org/erikedlund/amalgamate, which no longer exists; see
|
||||
`CHANGES.md` for the upstream commit this copy is based on)
|
||||
|
||||
`amalgamate.py` aims to make it easy to use SQLite-style C source and header
|
||||
amalgamation in projects.
|
||||
@@ -41,21 +41,22 @@ results.
|
||||
|
||||
## Installing amalgamate.py
|
||||
|
||||
Python v.2.7.0 or higher is required.
|
||||
Python 3 is required.
|
||||
|
||||
`amalgamate.py` can be tested and installed using the following commands:
|
||||
|
||||
./test.sh && sudo -k cp ./amalgamate.py /usr/local/bin/
|
||||
In this repository, `amalgamate.py` is not installed separately; it is run in
|
||||
place through `make amalgamate`, which calls it once for `json.hpp` and once
|
||||
for `json_fwd.hpp` (see the root `Makefile`).
|
||||
|
||||
## Using amalgamate.py
|
||||
|
||||
amalgamate.py [-v] -c path/to/config.json -s path/to/source/dir \
|
||||
[-p path/to/prologue.(c|h)]
|
||||
amalgamate.py -c path/to/config.json -s path/to/source/dir \
|
||||
[-p path/to/prologue.(c|h)] [--verbose=yes|no]
|
||||
|
||||
* The `-c, --config` option should specify the path to a JSON config file which
|
||||
lists the source files, include paths and where to write the resulting
|
||||
amalgamation. Have a look at `test/source.c.json` and `test/include.h.json`
|
||||
to see two examples.
|
||||
amalgamation. `config_json.json` and `config_json_fwd.json` in this
|
||||
directory are the configs used for `json.hpp` and `json_fwd.hpp`; each
|
||||
sets `target`, `sources` and `include_paths`.
|
||||
|
||||
* The `-s, --source` option should specify the path to the source directory.
|
||||
This is useful for supporting separate source and build directories.
|
||||
@@ -63,3 +64,6 @@ Python v.2.7.0 or higher is required.
|
||||
* The `-p, --prologue` option should specify the path to a file which will be
|
||||
added to the beginning of the amalgamation. It is optional.
|
||||
|
||||
* The `-v, --verbose` option takes `yes` or `no` (for example
|
||||
`--verbose=yes`, as used by the Makefile). It is optional.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user