External/cglm
1
0
Fork 0
mirror of https://github.com/recp/cglm.git synced 2025-10-04 09:08:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

remove cmocka from submodules and update docs

Browse Source
This commit is contained in:
Recep Aslantas
2019-09-12 07:10:37 +03:00
parent 981fd5ee44
commit 712cbee580
6 changed files with 7 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitmodules vendored
View File

@@ -1,3 +0,0 @@
[submodule "test/lib/cmocka"]
path = test/lib/cmocka
url = git://git.cryptomilk.org/projects/cmocka.git

7
.travis.yml
View File

@@ -37,7 +37,6 @@ branches:
- master - master
script: script:
- sh ./build-deps.sh
- sh ./autogen.sh - sh ./autogen.sh
- if [[ "$CC" == "gcc" && "$CODE_COVERAGE" == "ON" ]]; then - if [[ "$CC" == "gcc" && "$CODE_COVERAGE" == "ON" ]]; then
./configure CFLAGS="-ftest-coverage -fprofile-arcs"; ./configure CFLAGS="-ftest-coverage -fprofile-arcs";
@@ -49,7 +48,7 @@ script:
after_success: after_success:
- if [[ "$CC" == "gcc" && "$CODE_COVERAGE" == "ON" ]]; then - if [[ "$CC" == "gcc" && "$CODE_COVERAGE" == "ON" ]]; then
pip install --user cpp-coveralls && pip install --user cpp-coveralls &&
coveralls coveralls
--build-root . --build-root .
--exclude lib --exclude lib
@@ -58,5 +57,5 @@ after_success:
--verbose; --verbose;
fi fi
after_failure: # after_failure:
- cat ./test-suite.log # - cat ./test-suite.log

4
CONTRIBUTING.md
View File

@@ -1,11 +1,11 @@
# CONTRIBUTING # CONTRIBUTING
Any contributions (code, documentation, ...) are welcome. This project uses [cmocka](http://cmocka.org) for testing, you may need to check their documentation Any contributions (code, documentation, ...) are welcome.
# New Features # New Features
- This library may not accept all new features, it is better to create an issue and get approval before coding - This library may not accept all new features, it is better to create an issue and get approval before coding
- You must add test for every new feature - You must add test for every new feature
- The feature must be compiled in both UNIX/POSIX systems (e.g. macos, linux...) and Windows - The feature must be compiled on both UNIX/POSIX systems (e.g. macos, linux...) and Windows
# Code Style # Code Style
This library is written with C99, don't try to add C++ files (yes it can compiled into lib), This library is written with C99, don't try to add C++ files (yes it can compiled into lib),

2
README.md
View File

@@ -138,7 +138,7 @@ $ sh autogen.sh
$ ./configure $ ./configure
$ make $ make
$ make check # [Optional] $ make check # [Optional]
$ [sudo] make install $ [sudo] make install # [Optional]
``` ```
This will also install pkg-config files so you can use This will also install pkg-config files so you can use

8
docs/source/build.rst
View File

@@ -1,10 +1,7 @@
Build cglm Build cglm
================================ ================================
| **cglm** does not have external dependencies except for unit testing. When you pulled **cglm** repo with submodules all dependencies will be pulled too. `build-deps.sh` will pull all dependencies/submodules and build for you. | **cglm** does not have any external dependencies.
External dependencies:
* cmocka - for unit testing
**NOTE:** **NOTE:**
If you only need to inline versions, you don't need to build **cglm**, you don't need to link it to your program. If you only need to inline versions, you don't need to build **cglm**, you don't need to link it to your program.
@@ -16,8 +13,6 @@ Unix (Autotools):
.. code-block:: bash .. code-block:: bash
:linenos: :linenos:
$ sh ./build-deps.sh # run this only once (dependencies)
$ sh autogen.sh $ sh autogen.sh
$ ./configure $ ./configure
$ make $ make
@@ -65,4 +60,3 @@ Example build:
$ cd cglm/docs $ cd cglm/docs
$ sphinx-build source build $ sphinx-build source build

1
test/lib/cmocka

Submodule test/lib/cmocka deleted from 5f61d2f188