Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

ccp4m

This is the new CCP4M and will be the edition which I will work on.

Build Status Codacy Badge

Installation

There is a build.sh shell script to build the project on your system if there is no release binary for your system or you want the latest git commit version.

You will be required to install the dependencies manually, which are: yaml-cpp, and libcurl/curl.

Once build.sh generates the binary, it can be copied over to /usr/local/bin to run the program directly from any directory.

For Arch users

The software is available on the AUR under the name ccp4m.

Dependencies

For Debian based distros, install the dependencies using the following command:

sudo apt-get install libboost-all-dev libyaml-cpp-dev libcurl3 libcurl4-openssl-dev curl

If you have Ubuntu 18.04, use the following command ( just replaces libcurl3 with libcurl4 ):

sudo apt-get install libboost-all-dev libyaml-cpp-dev libcurl4 libcurl4-openssl-dev curl

For Arch based distros, if you want to build from source, install the curl and yaml-cpp package. That should be enough.

Instructions

Note: All the flag based parameters ( ones starting with '--' ) in any command are optional.

Creating a new project

To create a new project, the following command is used.

ccp4m project new test --lang c++ --version 0.1 --std 14 --author.name YourName --author.email YourEmail@emailprovider.com --build.name TestBuild --build.type bin --dir test

asciicast

Building a project

To build a project, the following command is used. Optionally, the build name can be provided to build a specific target. If not provided, it will build all the targets.

ccp4m project build < optional: target build >

asciicast

Executing a project

To run a project, the following command is used. You need to give a build target as a parameter so that it knows what to run.

ccp4m project run < target build > < arguments for the executable binary >

asciicast

Setting/Changing options in configuration

To change a configuration, the following command is used.

ccp4m project set < parameter > < value >

The parameter can be one of the following for now ( give me suggestions for more please ):

name - Project Name
version - Project Version
license - Project License
std - Project Standard
compile_flags - Project Compile Flags

asciicast

Cleaning directories

Cleaning project directories

The project directory is purged of the buildfiles, lib, and bin directories using the following command.

ccp4m project clean

asciicast

Cleaning CCP4M directories

The ~/.ccp4m directory can be cleared of logs and downloaded license files using the following command.

ccp4m clean < optional: log / license >

asciicast

Adding additional things

Additional items ( libraries, build targets, includes, and source files ) can be added.

Includes

ccp4m project add inc < include file name >

Include file name can contain directory as well ( but should not contain extension ).

asciicast

Sources

ccp4m project add src < source file name > < optional: target build >

Target build, if provided, will be the one for which the source file is valid ( depending on regex used for other sources in a build ).

asciicast

Builds

ccp4m project add build < build name > --type < bin/lib > --main_src < main source for this build > --exclude < comma separated list of sources to exclude > --srcs < comma separated list of sources to include ( other than main source ) >

Note that if main source is not provided, it will be taken as src/main.c(pp) by default. Also, if the type is lib, an extra parameter --build_type may be provided whose value is either statc or dynamic, by default it is static.

asciicast

Libraries

ccp4m project add lib < library name > --version < version > --inc_flags < include flags ( space separated ) > --lib_flags < library flags ( space separated ) >

By default, version is 0, include flags and library flags are empty.

asciicast

For another example of ccp4m.yaml, check out: Electrux/AsyncLoggingEngine

About

This is the new CCP4M and is the edition on which I work

Resources

License

Packages

No packages published