Commit Graph
47 Commits
Author SHA1 Message Date
Luca Mannella 84248a7884 Small update to README file
it could be necessary to execute make install
2022-09-12 17:29:47 +02:00
Eric Haszlakiewicz 2e9b7456a5 Update Travis links to point at travis-ci.com instead of travis-ci.org 2022-07-26 23:47:58 +00:00
Tobias Stoeckmann f63573460c Fix typo 2022-06-21 14:39:01 +02:00
Eric Haszlakiewicz f2fc1ca00a Note the DSIABLE_JSON_POINTER and DISABLE_EXTRA_LIBS build options on the README 2022-04-14 12:57:43 +00:00
Eric Haszlakiewicz acccefd770 Add a "Getting Help" section to the README. 2022-04-14 12:55:32 +00:00
Tobias Stoeckmann cbc603b587 Adjusted URLs
Most of these sites support HTTPS (some forward to HTTPS when accessing
the HTTP versions). Use HTTPS directly if supported.

Some URLs led to 404 error pages. Adjusted the links to point to
new locations.

I did not adjust the Microsoft HTML Help Workshop link because it seems
that this software is not available anymore. Instead of removing the
link entirely I kept it there in case it helps someone to find the
software on archived websites.
2022-03-19 10:34:55 +01:00
Tobias Nießen 928fa96db7 Fix typo in README 2022-01-10 00:12:25 +01:00
Eric Haszlakiewicz a5c2e11460 Cause the cmake include dirs to also have ${CMAKE_INSTALL_INCLUDEDIR}/json-c, so downstream packages that use cmake to link against json-c can choose whether to include headers as just e.g. #include <json_object.h>, if they care to do so.
Update the README to better explain this, and make a few other tweaks.
2021-12-22 02:52:37 +00:00
Eric Haszlakiewicz f1fb9abf14 Note the need to also set CTEST_OUTPUT_ON_FAILURE to get test output 2021-11-26 22:49:42 +00:00
Leon Gross 8be2ffdcd7 fix cmake version for tests 2021-10-06 15:29:33 +02:00
Jakov Smolic 55bf2d365d README: fix spelling errors
Signed-off-by: Jakov Smolic <jakov.smolic@sartura.hr>
2020-07-27 15:05:55 +02:00
Eric Haszlakiewicz 730e3d044f Issue #594 - provide an OVERRIDE_GET_RANDOM_SEED cmake variable to override json_c_get_random_seed() for embedded platforms where time(NULL) doesn't work.
Example:
mkdir build && cd build
cmake -DOVERRIDE_GET_RANDOM_SEED='do { extern uint32_t getMsTicks(void); int ms = getMsTicks() * 433494437; return ms; } while(0)' ..
2020-07-22 02:25:03 +00:00
Eric Haszlakiewicz 9a7de35b92 Add some more detail about how to use json-c in README.md. 2020-07-17 03:42:38 +00:00
Eric Haszlakiewicz 2508109b18 Remove the obsolete README.json_object-split.md, and mark README.md as being the doxygen mainpage. 2020-07-12 19:16:19 +00:00
Micah Snyder 60494684a1 Issue #508: -fPIC to link libjson-c.a with libs
json-c has symbol collisions with other popular C JSON libraries.
To prevent random crashes in downstream applications that may use a
library which depends on json-c, the solution is to statically link
libjson-c.a into those libraries.

`-fPIC`/`-fPIE` is required when building a `.a` so it can be linked
into a `.so`.
2020-06-14 12:35:49 -04:00
Björn Esser a85d2395ff README: Update configuration options for CMake. 2020-05-18 12:41:18 +02:00
dota17 e97fc20bfd update 2020-05-07 14:50:43 +08:00
dota17 952db0f397 support to build both static and shared libraries 2020-05-06 14:46:47 +08:00
Björn Esser 73a2ed115a Remove multiple trailing newlines at EOF. 2020-04-11 10:35:42 +02:00
Björn Esser 78cd37fb18 Clean trailing white-space. 2020-04-11 09:41:04 +02:00
Eric Haszlakiewicz 270dc2f999 Update README.md to remove autoconf instructions in favor of cmake. 2020-04-11 03:24:51 +00:00
dota17 203bacb24d add the badge in README.md and test the coveralls 2020-03-30 17:17:28 +08:00
dota17 1160c8625c Add uninstall target in cmake 2020-02-27 21:02:31 +08:00
dota17 e3b6521baa add doc target on cmake 2020-02-26 18:18:07 +08:00
Chen 0ccb296263 Update README.md 2020-02-25 16:20:41 +08:00
dota17 f69fbd897b Added documentation for camke-configure 2020-02-25 15:01:05 +08:00
Eric Haszlakiewicz bdaff94e9a Build and run the tests as part of the cmake build. 2019-11-23 15:15:48 -05:00
grdowns 7ef51239a9 Update dependencies 2019-09-26 17:11:49 -07:00
grdowns 760c1e284c Add vcpkg installation instructions 2019-09-26 17:09:39 -07:00
andy5995 1c7e891e44 "make its use in" [skip ci] 2019-07-26 12:59:24 -05:00
andy5995 e2f46b9f79 partial revert (make use) [skip ci] 2019-07-25 22:55:07 -05:00
andy5995 3969487376 README.md:fix 2 typos 2019-07-23 23:43:59 -05:00
Eric Haszlakiewicz 6460446aa6 Switch to building a dynamic lib by default. Tweak language in the README.md slightly. Inspired by PR#452. 2018-12-11 20:59:08 -05:00
andy5995 71f5c2d50b README.md:fix dead "file.html" link 2018-11-25 06:51:21 -06:00
Unmanned Player f2e991a341 The real CMake support
This patch provides a CMakeLists.txt file to build JSON-C library without relying on auto-tools support. This makes the build a bit more portable and cleaner.

It can detect headers and symbols and generate config.h header file based on those detections. It cannot yet handle ctest(1) as the testing itself depends on comparing the output against files. Testing would need some creative abuse of CMake :) This will be provided a few patches later and may possibly involve refactoring test cases.

The patch has been tested on GCC 4.8.5 (Linux), GCC 7.2.0 (MinGW) and Microsoft Visual C++ 16.0 (2010?) locally. Also, compiles correctly on Travis CI and AppVeyor without errors.
2018-07-24 08:06:13 +10:00
Alexander Dahl 89747ac758 doc: Use other doxygen feature to specify mainpage
Previously a special tag was added to README.md to make this the
main page in Doxygen generated docs. When viewing the README on the
GitHub page this tag was not hidden.

After upgrading to Doxygen 1.8.8 (and above) in changeset
219025727d a new Doxygen feature can be
used to specify the main page: Since release 1.8.3 Doxygen has a special
option to set a markdown file as main page. When using this option we
can drop the tag, making the README rendered by GitHub nice to look at.

Fixes: ae66b24369
2017-12-11 09:46:28 +01:00
Eric Haszlakiewicz c01635e03e Rearrange README.md a bit and make it work better in the doxygen generated docs.
Also, add a table of contents, and a brief section on using json-c with links to
the header files most likely to be useful.
2017-12-05 18:01:43 -05:00
Eric Haszlakiewicz 2d1da5ab13 Add a --enable-threading configure option, and only use the (slower) __sync_add_and_fetch()/__sync_sub_and_fetch() function when it is specified. 2017-09-03 23:37:12 -04:00
Alexandru Ardelean 061afc7993 README.md: show build status tag from travis & appveyor.
Looks nice to see a `Build Passing` tag when you
scroll to the README.

Signed-off-by: Alexandru Ardelean <ardeleanalex@gmail.com>
2017-07-10 11:45:24 +03:00
Eric Haszlakiewicz 5e33dabda1 Issue #308: improve the build instructions in README.md to include the exact commands to run for installing prerequisites, as mentioned earlier on Issue #308. 2017-07-08 19:35:06 -07:00
Eric Haszlakiewicz 779b77a164 Note some minimum versions needed for autoconf, etc... 2016-12-12 23:01:20 -05:00
Nicola Spanti (RyDroid) f2e7dda910 Improving README 2016-08-08 15:25:31 +02:00
Eric Haszlakiewicz ae66b24369 Mention that we're aiming to follow RFC 7159 now.
Cause README.md to show up in Doxygen output as the main page.
2016-06-08 02:37:15 +00:00
Michael Clark 0e1a057449 Remove reference to svn.metaparadigm.com
svn.metaparadigm.com no longer exists so it is not possible to use source from there.
2016-06-07 08:11:16 +12:00
Eric Haszlakiewicz 4569e3e430 Fix minor typo in README file. 2014-04-19 20:11:05 -04:00
Haneef Mubarak 7870978c2e Update README.md
- code blocks
 - slight text changes (rewording)
 - pretty printing
2014-04-12 00:40:05 -07:00
Haneef Mubarak 23620b827c Update and rename README to README.md
Markdownify + fix a few errors here and there
2014-04-12 00:36:08 -07:00