summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Revert "Add LGTM.com code quality badges to README"Ivan Maidanski2023-01-251-2/+0
| | | | | | This reverts commit f94d1939f7806ce337bec37fed0e3db14caa050f. The reason: LGTM badges are no longer supported.
* Update Travis CI badge URL in READMEIvan Maidanski2022-08-031-1/+1
|
* Add OpenSSF Best Practices badge to READMEIvan Maidanski2022-08-031-0/+1
|
* Add FOSSA badge to READMEIvan Maidanski2022-05-191-1/+1
|
* Refine LICENSE and README about code parts covered by MIT and GPL-2.0Ivan Maidanski2021-11-261-31/+22
| | | | | | | | | | | | | | | | | | * LICENSE: Mention MIT and GPL-2.0 at the top of the file; copy copyrights from README.md; group all copyrights in one block; explicitly specify which code is covered by MIT and which one by GPL; remove a statement about the possibility of license change in future. * README.md: Refine the statement about new code to use C11 atomics; specify license type at the top of the file. * README.md (Overview): Mention that README_malloc.txt and README_stack.txt describe the functionality of libatomic_ops_gpl. * README.md (Installation and Usage): Mention that libatomic_ops.a is a core library and libatomic_ops_gpl.a is a gpl extension library; mention that libatomic_ops_gpl.a licensing details are given in COPYING and LICENSE files. * README.md (Copyright & Warranty): Rename to "Copyright & Warranty, Contributors"; remove all copyrights (they are moved to LICENSE); better explain the dual nature of the license.
* Add repology.org badge to READMEIvan Maidanski2021-11-091-0/+1
|
* Rename LICENSING.txt to LICENSEIvan Maidanski2021-11-081-3/+3
| | | | | | | | | | The license file is more traditionally named as LICENSE. * CMakeLists.txt [enable_docs] (install): Rename LICENSING.txt to LICENSE. * Makefile.am [ENABLE_DOCS] (dist_doc_DATA): Likewise. * README.md (Installation and Usage, Copyright & Warranty): Likewise. * LICENSING.txt: Rename to LICENSE.
* Support build with CMakeIvan Maidanski2021-11-081-1/+6
| | | | | | | | | | * CMakeLists.txt: New file. * Config.cmake.in: Likewise. * Makefile.am (EXTRA_DIST): Add CMakeLists.txt, Config.cmake.in. * README.md (Installation and Usage): Describe shortly how to build the package with CMake (and how to disable GPL code in case of CMake). * README_win32.txt: Likewise. * README_details.txt: Document cmake-based build.
* Build libatomic_ops.lib by Makefile.msft (MS VC)Ivan Maidanski2021-11-071-2/+4
| | | | | | | | | | | | | | | | | | | | | | | | This unifies the build artifacts between the supported build systems. Note that the clients relying on Makefile.msft should now link with libatomic_ops.lib in addition to libatomic_ops_gpl.lib. * README.md (Platform Specific Notes): Updade documentation about Makefile.msft which also builds libatomic_ops.lib now. * README_win32.txt: Likewise. * README_win32.txt: Refine documentation (separate the package build from client code compilation). * src/Makefile.msft (LIB_GPL_OBJS): New variable. * src/Makefile.msft (LIB_OBJS): Move atomic_ops_malloc.obj and atomic_ops_stack.obj to LIB_GPL_OBJS. * src/Makefile.msft (all-disable-gpl, libatomic_ops.lib): New goal (builds only non-GPL code). * src/Makefile.msft (all): Depend on all-disable-gpl. * src/Makefile.msft (libatomic_ops_gpl.lib): Depend and use LIB_GPL_OBJS instead of LIB_OBJS. * src/Makefile.msft (test_malloc, test_stack): Also depend and link with libatomic_ops.lib. * src/Makefile.msft (clean): Delete libatomic_ops*.lib.
* Reference AUTHORS file in READMEIvan Maidanski2021-11-041-0/+2
| | | | * README.md (Copyright & Warranty): Add a link to AUTHORS file.
* New configure option (--disable-gpl) to skip building of libatomic_ops_gplIvan Maidanski2021-11-021-1/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Makefile.am [ENABLE_DOCS] (dist_doc_DATA): Do not add COPYING, README_malloc.txt, README_stack.txt items unless ENABLE_GPL. * README.md (Installation and Usage): Add note that libatomic_ops_gpl.a is not built if --disable-gpl option is given to configure. * configure.ac (gpl): New AC_ARG_ENABLE. * configure.ac (ENABLE_GPL): New AM_CONDITIONAL. * src/Makefile.am (include_HEADERS): Do not add atomic_ops_malloc.h and atomic_ops_stack.h items unless ENABLE_GPL. * src/Makefile.am (lib_LTLIBRARIES): Do not add libatomic_ops_gpl.la unless ENABLE_GPL. * src/Makefile.am (libatomic_ops_gpl_la_SOURCES, libatomic_ops_gpl_la_LDFLAGS, libatomic_ops_gpl_la_LIBADD): Do not define unless ENABLE_GPL. * tests/Makefile.am (test_stack_SOURCES, test_stack_LDADD, test_malloc_SOURCES, test_malloc_LDADD): Likewise. * tests/Makefile.am [ENABLE_SHARED] (test_malloc_LDADD, test_stack_LDADD): Likewise. * tests/Makefile.am (TESTS): Do not add test_malloc$(EXEEXT) and test_stack$(EXEEXT) items unless ENABLE_GPL. * tests/Makefile.am (TEST_OBJS): Do not add test_malloc.o, test_stack.o items unless ENABLE_GPL. * tests/Makefile.am (check_PROGRAMS): Do not add test_malloc and test_stack items unless ENABLE_GPL. * tests/Makefile.am (check-gpl-without-test-driver): New PHONY goal. * tests/Makefile.am (check-without-test-driver): Depend also on check-gpl-without-test-driver; do not run test_stack and test_malloc directly.
* Move all README and license files to the top folderIvan Maidanski2021-11-011-5/+13
| | | | | | | | | | | | | | | | | | | | | | | The rationale: all relative links (in README.md) should remain valid after docs installation. * doc/LICENSING.txt: Move to the base folder. * doc/README_details.txt: Likewise. * doc/README_malloc.txt: Likewise. * doc/README_stack.txt: Likewise. * doc/README_win32.txt: Likewise. * Makefile.am (SUBDIRS): Remove doc item. * Makefile.am [ENABLE_DOCS] (dist_doc_DATA): Add comment and items from doc/Makefile.am. * README.md (Overview): Replace reference to doc with the links to the existing README_*.txt files (except for README_win32.txt). * README.md (Installation and Usage): Add link to LICENSING.txt. * README.md (Platform Specific Notes): Add link to README_win32.txt. * README.md (Copyright & Warranty): Adjust link to LICENSING.txt (after moving to the base folder). * configure.ac (AC_CONFIG_FILES): Remove doc/Makefile item. * doc/Makefile.am: Remove file. * src/atomic_ops_malloc.h: Update path to LICENSING.txt in comment.
* Adjust/reformat text of LICENSING.txtIvan Maidanski2021-11-011-2/+3
| | | | | | | | * README.md (Installation and Usage, Copyright & Warranty): Refine information about LICENSING.txt file. * doc/LICENSING.txt: Rename sysdeps folder to atomic_ops/sysdeps; reformat text a bit; do not mention "sample applications" (because only tests are available).
* Fix link URL of shields.io badges in READMEIvan Maidanski2021-08-131-3/+3
| | | | | Place URL to shields.io/category instead of empty one (which led to missing page on Github).
* Update CI badge in README after migration to travis-ci.comIvan Maidanski2021-06-201-1/+1
|
* Remove hits.dwyl.com badge in READMEIvan Maidanski2021-06-121-1/+0
| | | | HitCount (unique visitors count) service is not working as of now.
* Add hitsofcode.com, shields.io, hits.dwyl.com badges to READMEIvan Maidanski2021-01-151-0/+6
| | | | | | | | | The following badges are added to README.md (in the 2nd row): * Hits-of-Code (for master branch) * Lines of code (for master branch) * GitHub code size in bytes * Github All Releases (downloads counter) * HitCount (README page unique visitors count)
* Link to doc/LICENSING.txt in READMEIvan Maidanski2021-01-151-2/+2
| | | | | * README.md (Copyright & Warranty): Update copyright year. * README.md (Copyright & Warranty): Add a link to doc/LICENSING.txt.
* Update copyright year in configure and READMEIvan Maidanski2019-03-061-1/+1
| | | | | * README.md: Update year (to 2019) in the Copyright. * configure.ac: Likewise.
* Add Codecov.io badge to READMEIvan Maidanski2018-09-031-0/+1
|
* Add LGTM.com code quality badges to READMEXavier Rene-Corail2018-08-301-0/+2
|
* Update copyright information in README and some header filesIvan Maidanski2018-07-261-1/+22
| | | | | | | | | | | | | | | | * README.md (Copyright & Warranty): Add copyrights from the source code files. * src/atomic_ops.h: Update header copyright (add Ivan Maidanski). * src/atomic_ops/ao_version.h: Likewise. * src/atomic_ops/sysdeps/gcc/aarch64.h: Likewise. * src/atomic_ops/sysdeps/gcc/arm.h: Likewise. * src/atomic_ops/sysdeps/gcc/generic.h: Likewise. * src/atomic_ops/sysdeps/gcc/x86.h: Likewise. * src/atomic_ops/sysdeps/loadstore/double_atomic_load_store.h: Likewise. * src/atomic_ops/sysdeps/msftc/arm.h: Likewise. * src/atomic_ops/sysdeps/msftc/common32_defs.h: Likewise. * src/atomic_ops/sysdeps/sunc/x86.h: Likewise.
* Fix a typo in the overview section of READMEIvan Maidanski2018-04-021-1/+1
| | | | | | (fix of commit 147988d9) * README.md (Overview): Fix typo ("a number of") in documentation.
* Add bdwgc mailing list online archive link to READMEIvan Maidanski2017-06-161-2/+5
| | | | | | * README.md (Feedback, Contribution, Questions and Notifications): Update information about accessing the mailing list archive (add link to that at Narkive site).
* Update README about bugs reporting and new releases notificationIvan Maidanski2017-06-021-2/+25
| | | | | | | | * README.md (Download): Move (and update) information about bug reporting to another section. * README.md (Feedback, Contribution, Questions and Notifications): New section. * configure.ac (AC_INIT): Change URI for reporting bugs.
* Bump libatomic_ops versionIvan Maidanski2017-05-191-1/+6
| | | | | | | | | * README.md: Bump version to 7.7.0. * .travis.yml (addons.coverity_scan.project.version): Likewise. * appveyor.yml (version): Likewise. * configure.ac (AC_INIT): Likewise. * src/atomic_ops/ao_version.h (AO_VERSION_MINOR): Likewise. * README.md: Add back the build status indicators for "master" branch.
* [7.6.0]v7.6.0Ivan Maidanski2017-05-191-6/+1
| | | | | | | | | | | | | | | | | | Bump libatomic_ops version to 7.6.0 * ChangeLog (7.5.0): Bump version (to 7.6.0). * .travis.yml (addons.coverity_scan.project.version): Likewise. * README.md: Likewise. * appveyor.yml (version): Likewise. * configure.ac (AC_INIT): Likewise. * src/atomic_ops/ao_version.h (AO_VERSION_MINOR): Likewise. * ChangeLog (7.6.0, 7.4.6): Add release date. * README.md: Remove build status indicators for "master" branch. * src/Makefile.am (LIBATOMIC_OPS_GPL_VER_INFO): Change to 2:1:1 (increment revision number) because libatomic_ops_gpl.so implementation has been updated (since the last change of the version info). * src/Makefile.am (LIBATOMIC_OPS_VER_INFO): Change to 2:1:1 (just to stay aligned with LIBATOMIC_OPS_GPL_VER_INFO).
* Use 'inline code' format for commands in README.mdIvan Maidanski2017-05-181-11/+12
| | | | | * README.md: Quote commands with a grave accent character ("`"); the same for names containing an underscore; reformat text.
* Add Coverity Scan (static code analysis status) badge to READMEIvan Maidanski2017-04-191-0/+1
|
* Add Coveralls (test coverage status) badge to READMEIvan Maidanski2017-01-311-0/+1
|
* Add CI (continuous integration) badges to READMEIvan Maidanski2016-08-181-1/+4
|
* Refine README how to build the library source from the repositoryIvan Maidanski2016-08-181-1/+2
| | | | | * README.md (Installation and Usage): Add information that autogen.sh should be launched first if building from the development repository.
* Refine README about library downloadingIvan Maidanski2016-08-181-3/+9
| | | | | * README.md (Download): New section; add link to Download page (located on GitHub); add information about the code repository.
* Add disclaimer to README to favor C11/C++14 atomics over libatomic_ops useHans Boehm2016-05-231-0/+2
| | | | | | * README.md: Add top-level disclaimer that it is better to use C11 or C++14 atomic primitives instead of this library for the newly-developed code.
* Update emails/links due to project site transitionIvan Maidanski2014-02-211-3/+3
| | | | | | | | * AUTHORS: Update email. * README.md: Update links to BDWGC/libatomic_ops site. * doc/README_stack.txt: Likewise. * README.md: Update mailing list info. * configure.ac: Likewise.
* Bump atomic_ops versionIvan Maidanski2014-01-311-1/+1
| | | | | | * README.md: Bump version to 7.5.0. * configure.ac: Likewise. * src/atomic_ops/ao_version.h (AO_VERSION_MINOR): Likewise.
* [7.4.0]libatomic_ops-7_4_0Ivan Maidanski2013-11-171-1/+1
| | | | | | | | | | | Bump version to 7.4.0; change policy regarding version numbers * ChangeLog: Update. * README.md: Bump version. * configure.ac (AC_INIT): Likewise. * src/atomic_ops/ao_version.h (AO_VERSION_MINOR): Likewise. * src/atomic_ops/ao_version.h (AO_VERSION_ALPHA): Replace to AO_VERSION_MICRO; add comment.
* Convert README to Markdown formatIvan Maidanski2013-09-121-0/+63
* README: Rename to README.md; adjust formatting to follow Markdown syntax.