Skip to content
Matlab-compatible jsonencode/jsondecode functions for GNU Octave
C++ MATLAB Makefile M Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea
dev-tools
doc-project
doc
inst
opp
src
.editorconfig
.gitignore
.travis.yml
CMakeLists.txt
CODE_OF_CONDUCT.md
CONTRIBUTING.md
CONTRIBUTORS.md
COPYING
DESCRIPTION
INDEX
Makefile
README.md
__jsonstuff_make_local__.m
__run_tests_and_exit__.m
__test_pkgs__.m

README.md

Chrono for GNU Octave

WARNING: All the code in here is currently in the alpha stage. (Pre-beta, that is.) Do not use it in any production or business code! Seriously!!

JSON encoding/decoding functionality for GNU Octave.

This package attempts to provide a set of Matlab-compatible JSON encoding and decoding functions, namely jsonencode and jsondecode.

Installation and usage

Quick start

To get started using or testing this project, install it using Octave's pkg function:

pkg install https://github.com/apjanke/octave-jsonstuff/releases/download/v0.2.0/jsonstuff-0.2.0.tar.gz
pkg load jsonstuff

Installation for development

  • Clone the repo.
    • git clone https://github.com/apjanke/octave-jsonstuff
  • Run make dist in a shell.
  • Install the resulting target/jsonstuff-X.Y.Z.tar.gz package file by running pkg install /path/to/repo/octave-jsonstuff/target/jsonstuff-X.Y.Z.tar.gz in Octave.
  • Lather, rinse, and repeat each time you make changes to any of the source code.

Requirements

  • Octave 4.4 or newer

JsonStuff runs on Octave 4.4.0 and later. It would be nice to have it work on Octave 4.0.0 and later (since Ubuntu 16 Xenial has Octave 4.0 and Ubuntu 18 Bionic has Octave 4.2); maybe we'll do that some day.

JsonStuff works on macOS, Linux, and Windows. (Though our CI is not running on Windows yet.)

Documentation

The user documentation is in the doc/ directory. See doc/jsonstuff.html or doc/html/index.html for the manual.

There's a FAQ in doc-project/.

The developer documentation (for people hacking on JsonStuff itself) is in doc-project/. Also see CONTRIBUTING if you would like to contribute to this project.

“Internal” code

Anything in a namespace with internal in its name is for the internal use of this package, and is not intended for use by user code. Don't use those! Resist the urge! If you really have a use case for them, post an Issue and we'll see about making some public API for them.

License

JsonStuff is Free Software.

The JsonStuff code itself is licensed under the GNU GPLv3.

JsonStuff includes a redistribution of the JsonCpp library as source code, which is licensed under Public Domain and the MIT License.

Author and Support

JsonStuff is created by Andrew Janke.

Support is available on a best-effort basis via the JsonStuff GitHub repo. If you have a problem with JsonStuff, post an issue on the Issue Tracker there.

The project's author also hangs out in the #octave channel on freenode IRC. You can ask questions there.

You can’t perform that action at this time.