https://github.com/sanix-darker/c-starter
A small and lightweight C starter application(Cello, Clib, Unittests, etc...).
https://github.com/sanix-darker/c-starter
c cello clib starter starter-template test
Last synced: 7 months ago
JSON representation
A small and lightweight C starter application(Cello, Clib, Unittests, etc...).
- Host: GitHub
- URL: https://github.com/sanix-darker/c-starter
- Owner: Sanix-Darker
- License: mit
- Created: 2020-05-10T02:56:23.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-25T09:34:35.000Z (over 2 years ago)
- Last Synced: 2025-01-29T23:28:15.382Z (8 months ago)
- Topics: c, cello, clib, starter, starter-template, test
- Language: C
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# C-starter
A small and lightweight C starter application.
## Features
- A Hight level programming based on [Cello](http://libcello.org/learn).
- A package manager implemented with [CLib](https://github.com/clibs/clib).
- A Basic unitTest with asserts.
- A documentation template (not up to date).
## Project tree
The project structure :
```shell
.
├── build.sh
├── cello_install.sh
├── clib_install.sh
├── doc
│ └── index.html
├── README.md
├── run.sh
├── run_tests.sh
├── src
│ ├── func.c
│ ├── headers
│ │ └── func.h
│ └── main.c
└── tests
├── assert.h
└── tests.c
```
## To install
Works only for Linux users (Ubuntu/Debian), you just have to run :
```shell
# First install cello
bash ./cello_install.sh
# or
make install-cello
# Then install clib
# clib is a packet manager for c libraries
bash ./clib_install.sh
# or
make install-clib
# To search a C-library
# clib search [package-name]
# -
# To Install the C-library
# clib install /
```
## To build and run
To build your app in `./src`, you just have to run :
```shell
sh ./build.sh
# app.bin will be generated, now you can run it by hitting :
./dist/app.bin
# or make run, will build and execute it
make dev
# replace dev by prod to have an optimized portable executable with no debug logs
```
## Documentation
A Documentation template is in `./doc` and will be updated !
## To run Tests
I implemented a basic assert method in tests to performs some tests on methods in `./src/func.c`, you just have to run :
```shell
bash ./run_tests.sh
# Expected ouutput :
# [+] -----------------------------------------------
# [+] Start tests...
# [+]
# [+] > 'test_helloworld()' passed successfully,
# [+] ===============================================
# [+] Reports 1/1 tests passed !
# [+] -----------------------------------------------
```
Otherwhise, you can use `cmocka`, an elegant unit testing framework for C with support for mock objects; install it by running:
```shell
# After installed clib
clib install cmocka
```
## Bonus For building your own Clib
**Note : You don't need this in this project, it just show you how to create a CLib if you want to !**
If you want to create a C-Lib library, you just have to put in the root of your repo a `package.json` file with this kind of structure :
```json
{
"name": "repo",
"author": "darker",
"version": "0.0.1",
"repo": "/",
"description": "The description",
"keywords": ["some", "keywords"],
"license": "MIT",
"src": ["src/main.c", "src/main.h"]
}
```
## Author
- Sanix-darker
## LICENSE
[MIT License](https://github.com/Sanix-Darker/c-starter/blob/master/LICENSE)