https://github.com/sohaibqasem/linux-create-cxx-project
easy to use shell script to create c++ project in linux using cmake with npm
https://github.com/sohaibqasem/linux-create-cxx-project
bash bash-script cmake cplusplus create-cxx-project cxx linux npm npm-package npm-scripts npx shell
Last synced: 5 months ago
JSON representation
easy to use shell script to create c++ project in linux using cmake with npm
- Host: GitHub
- URL: https://github.com/sohaibqasem/linux-create-cxx-project
- Owner: sohaibqasem
- License: mit
- Created: 2020-05-09T05:48:32.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-06-15T16:46:07.000Z (about 6 years ago)
- Last Synced: 2025-02-12T17:54:38.029Z (over 1 year ago)
- Topics: bash, bash-script, cmake, cplusplus, create-cxx-project, cxx, linux, npm, npm-package, npm-scripts, npx, shell
- Language: Shell
- Homepage:
- Size: 64.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://img.shields.io/badge/os-linux-green)
[](https://img.shields.io/github/license/sohaibqasem/linux-create-cxx-project)
# linux-create-cxx-project
easy to use shell script using cmake to create c++ project
Create c++ project works on Linux.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask
### Main fetures
* Complie whatever you have written
* Import static libraries to your project
* Import shared libraries to your project
### New
* Generate static, shared libraries and link it to your projects
* Add setup script for easy installation
* manage the project throgh npm scripts
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
## OverView
### Prerequisites
you will need to install **cmake**, **make**, **g++**, you can install these tools from your package manager
* To check if a dependenciy installed
```
--version
```
## How to use
```
npx linux-create-cxx-project
cd
npm start
npm run exe
```
## Install it locally
- clone it
- run
```
cd linux-create-cxx-project
sudo ./setup.sh
cd && echo "export PATH=\$PATH:/usr/local/bin/linux-create-cxx-project" >> .bashrc
```
- navigate where you want to create the project and run:
```
create-cplusplus-project.sh
```
enjoy coding :rocket:
### Use Cases
* Navigate to what dir you want
* run the script
Ex:
```
npx linux-create-cxx-project
```
### To build and compile your code
```
npm start
npm run exe
```
### To build a release
```
npm release
npm run exe
```
### To import static library
* Move header files to include dir
* Move xxx.a file to libs dir
### To import dynamic library
* Move header files to include dir
* Move xxx.so file to libs dir
### To create a library
```
npm run create-lib
```
* lib types
- st >> static
- dy >> shared
- to build the library run
```
npm run build-lib
```
- to build the library and link it run
```
npm run build-lib
```
Note: everytime you make change to the library you need to build it again
### C++ Project Structure
```
build/
include/
src/
./build.sh
.
.
build/
include/
libs/
src/
Main.cpp
.
.
scripts/
release.sh
start.sh
create-lib.sh
build-lib.sh
```
## Built With
* Shell script - used to generate the project structure and sample code
## Contributing
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details