{"id":19558271,"url":"https://github.com/silwalanish/cpp-starter-kit","last_synced_at":"2025-10-04T18:33:21.318Z","repository":{"id":141599335,"uuid":"266577575","full_name":"silwalanish/cpp-starter-kit","owner":"silwalanish","description":"A Makefile to compile, link and build c++ project.","archived":false,"fork":false,"pushed_at":"2021-12-19T09:32:49.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-08T22:03:12.447Z","etag":null,"topics":["build-tool","cpp","makefile"],"latest_commit_sha":null,"homepage":null,"language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/silwalanish.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-24T16:12:10.000Z","updated_at":"2022-01-25T01:30:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"a635b2ea-f9ad-49f2-a0bf-a1626c354a39","html_url":"https://github.com/silwalanish/cpp-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silwalanish%2Fcpp-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silwalanish%2Fcpp-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silwalanish%2Fcpp-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/silwalanish%2Fcpp-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/silwalanish","download_url":"https://codeload.github.com/silwalanish/cpp-starter-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240814857,"owners_count":19861958,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["build-tool","cpp","makefile"],"created_at":"2024-11-11T04:46:39.654Z","updated_at":"2025-10-04T18:33:16.266Z","avatar_url":"https://github.com/silwalanish.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# cpp-starter-kit\nA simple attempt at making building c++ projects easier.\n\n# Features\n- Uses [conan.io](https://conan.io/) to manage dependencies.\n- Uses [make](https://www.gnu.org/software/make/) as build system.\n- Uses [gtest](https://github.com/google/googletest) for unit tests.\n\n# Usage\n## Creating a new project\n- Clone the repository.\n- Update the name and description of the project in the file `ProjectInfo.mk`.\n\nAlternatively,\n- Run the `create-cpp-project` script.\n```bash\n$ bash \u003c(curl -s https://raw.githubusercontent.com/silwalanish/cpp-starter-kit/main/create-cpp-project.sh) -n ${PROJECT_NAME} -p ${PROJECT_PATH}\n```\n\n## Configurations\n- Add any build parameters in `BuildOptions.mk`.\n- Add dependencies in `conanfile.py`.\n\n## `setup`\nInstall dependencies\n```bash\n$ make setup\n```\n\n## `compile`\nRun to compile the project.\n```bash\n$ make compile\n```\n\n## `build`\nRun to link and build the executable. Will create a executable name as `{EXECUTABLE_NAME}` set in `BuildOptions.mk`.\n```bash\n$ make build\n```\nOr just\n```bash\n$ make\n```\n\n## `run`\nRun to execute the project.\n```bash\n$ make run\n```\n\n## `test`\nRuns the unit tests.\n```bash\n$ make test\n```\n\n## `clean`\nRun to clean compile artifacts.\n```bash\n$ make clean\n```\n\n# Project Structure\n```\n\\\n|--\u003e includes\n|--\u003e libs\n|--\u003e src\n|--\u003e vendor\n```\n\n## includes\n- Contains the header files for external dependencies.\n```\nincludes\n|--\u003e Dependency1 \n|--\u003e Dependency2\n.\n.\n.\n|--\u003e DependencyN\n```\n\u003e Note: Use [conan](https://conan.io/) to install dependencies if possible.\n\n## libs\n- Stores the static build of library of external dependencies\n```\nlibs\n|--\u003e Debug\n     |-\u003e Linux\n         |-\u003e x86\n             |-\u003e Dependency1.lib\n             |-\u003e Dependency2.lib\n         |-\u003e x64\n             |-\u003e Dependency1.lib\n             |-\u003e Dependency2.lib\n     |-\u003e Win\n         ...\n     |-\u003e MacOs\n         ...\n|--\u003e Release\n     |-\u003e Linux\n         ...\n     |-\u003e Win\n         ...\n     |-\u003e MacOs\n         ...\n```\n\u003e Note: Use [conan](https://conan.io/) to install dependencies if possible.\n\n## src\n- Source files for the project.\n\n# How to install a dependency?\n## Avaliable as conan package?\n- If available as a conan package, add the package in `conanfile.py`.\n\n## Header Only?\n- Add the headers in the `includes` directory.\n\n## Prebuilt binary and headers available?\n- Add headers to `includes` directory.\n- Add prebuilt binaries to `libs` directory.\n- Update `CCFLAGS`/`CFLAGS` in `BuildOptions.mk` to link the library.\n\n## Need to build manually?\n- Build the dependency following the instruction for the dependency.\n- Copy the binaries to `libs` directory.\n- Update `CCFLAGS`/`CFLAGS` in `BuildOptions.mk` to link the library.\n- Copy the headers to `includes` directory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilwalanish%2Fcpp-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsilwalanish%2Fcpp-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsilwalanish%2Fcpp-starter-kit/lists"}