# coddle

**Repository Path**: lfnpcsoft_admin/coddle

## Basic Information

- **Project Name**: coddle
- **Description**: Coddle
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-01-31
- **Last Updated**: 2023-01-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Coddle

[![Build Status](https://travis-ci.com/coddle-cpp/coddle.svg?branch=master)](https://travis-ci.com/coddle-cpp/coddle)

Yet another build and package system. :)

Your project have only C/C++ source code, the tool is figuring out and
installing all dependencies automatically. No config or make files required.

You create source files such as src1.cpp, src2.cpp, header1.hpp, header2.hpp in
the directory of your project "prj". Type:

```
$ coddle
```

The build system will automatically figure out how to make the binary out of
your source code. No configuration file is required at all.

The goal is to make it work for Windows, Linux, Mac OS X and iOS (Android maybe).

A decision was made to support clang only.

## Dependencies

- computer or laptop
- git
- clang
- access to the Internet (sorry the tool would work purely without Internet)

### Linux
- see above

### MacOSX
- brew if you want to use pkgconfig

### Windows
- MSYS2

## Deployment

### Linux/MacOSX
```
$ git clone https://github.com/coddle-cpp/coddle.git && cd coddle && ./build.sh && sudo ./deploy.sh; cd ..
```

### Windows
```
$ git clone https://github.com/coddle-cpp/coddle.git && cd coddle && ./win_build_deploy.sh; cd ..
```

## Configuration

Sometimes you would need a configuration.

The config file is coddle.toml

### target

The name of your binary or library.

The default value is the name of the directory.

Example:

```
target="my_new_project"
```

### remoteRepository

The git link to the package repository.

Default value: ```https://github.com/coddle-cpp/coddle-repository.git```

Example:
```
remoteRepository="https://github.com/coddle-cpp/coddle-repository.git"
```

### remoteVersion
Git branch or tag for the package repository.

Default value: ```master```, ```win``` for Windows and ```macosx``` for MacOSX.

Example:

```
remoteVersion="master"
```

### localRepository
Path to the local repository. Values of the local repository override values from remote repository.

The default value is an empty string.

Example:
```
localRepository="../coddle-repository"
```

### srcDir
Path to the directory where located source files.

Default value: ```.``` current directory.

Example:
```
srcDir="src"
```

### targetDir
The path where coddle should put binary.
Default value: ```.``` current directory.

Example:
```
targetDir="bin"
```
### artifactsDir
Path where coddle should put build artifacts.

Default value: ```.coddle```

Example:
```
artifactsDir="build"
```

### debug
Sets the level of optimization and symbols. If debug set optimization is
disabled and symbols are included in the binary.

Default value: ```false```

Example:
```
debug=true
```

You also can set debug from the command line:
```
coddle debug
```

### multithreaded

Specifies if your project uses threads.

Default value: ```false```

I was not able to figure out how to detect it automatically. Sorry...

Example:
```
multithreaded=true
```

### winmain

Specifies if your project is a Windows application.

Default value: ```false```

Example:
```
winmain=true
```

## shared

If set to true, will make a shared library instead of a static one.

Default value: ```false```
Example:
```
shared=true
```

## Repository format

Your repository should have libraries.toml file. The file is just a list of libraries.

Example of one entry:

```
[[library]]
type="git"
name="cpptoml"
path="https://github.com/skystrife/cpptoml.git"
includes=["cpptoml.h"]
incdir="include"
incdirs=["include1", "include2"]
```

### type
Library type. Possible values: ```git```, ```pkgconfig```, ```lib```.

Example:
```
type="lib"
```

### name
Name of the library.
In case of pgkconfig name has to match with the pkgconfig name.

Example:
```
name="cpptoml"
```

### path
Path to the library. It might be git URL or path to the directory.

Example:
```
path="https://github.com/skystrife/cpptoml.git"
```

### version
Only for git type, branch or tag.

Default value: ```master```

Example:
```
version="1.0.1"
```

### postClone
One line bash script after cloning the git repository.

### includes
Coddle detects dependencies automatically based on included files in
the source files. includes array makes the mapping between includes in your
source code and dependent libraries.

Example:
```
includes=["cpptoml.h"]
```

### incdir or incdirs
The path where the library includes files is located.

Example:
```
incdir="include"

```

### libdir
The path where the library file is located (-L clang link option).
Example:
```
libdir="libs"
```