Metadata-Version: 2.1
Name: makefile-creator
Version: 0.0.4b1
Summary: MakeFile-Creator for makefiles management in c/c++ projects.
Home-page: https://github.com/m3sserschmitt/MakeFile-Creator.git
Author: Romulus-Emanuel Ruja
Author-email: romulus-emanuel.ruja@tutanota.com
License: UNKNOWN
Description: # MakeFile-Creator
        
        MakeFile-Creator is an utility for managing makefiles in C/C++ projects.
        
        # Getting started
        
        These instructions will get you a copy of the project up and running on your local machine.
        
        ### Prerequisites
        
        `Python >= 3.6`
        
        ### Installing
        
        Install the package from Python Package Index using the command:
        
        `pip3 install makefile-creator`
        
        ### Configuration
        
        `cd /your/project/path`
        
        You have to create a configuration file, using JSON format as follows:
        You may want to use this command from terminal (or open your favourite text editor, and after you've done, save as `mfc.config.json`):
        
        `touch mfc.config.json`
        
        File content should be something like this:
        
        ```
        {
            "target": "your_project_name", 
        	"c_flags": [list, of, compiler, flags],
            "cc": "g++",
            "extensions": ["cc", "cpp"],
            "rm": "rm -v",
        	"ignore_paths": [
        		"comma/separated/list/of/paths/you/want/to/ignore",
                "path1",
                "path2",
                "and/so/on/..."
        	    ]
        }
        ```
        
        Meaning:
        * _**`target`:**_ you project name.
        * _**`c_flags`:**_ a list of compiler flags, like:
            
            `["-Wall", "-lpthread", "-other_flags..."]`.
        * **_`cc`:_** compiler command (`"g++"`, by default).
        * **_`extensions`:_** source files extensions list (`["cpp"]`, by default).
        * **_`rm`:_** command to use for **_`make clean`_** (`rm -v`, by default).
        * **_`ignore_paths`:_** paths into project source tree to ignore.
        
        ##### Other commands:
        
        * _**`clean`:**_ `true`, if you want to clean redundant dependencies .d files (`false`, by default).
        * _**`custom_targets`:**_ use as follows:
        ```
        "custom_targets": {
            "target_name": "command",
            "other_target": "other_command",
            ...
        }"
        ````
        * _**`ld_flags`**_: similar to `c_flags`, but flags set using this command will only be used
        at linkage.
        
        **Make sure to save the file as `mfc.config.json` !**
        
        Run the script:
        
        `python3 -m makefile_creator`
        
        ## Authors
        
        * **Romulus-Emanuel Ruja (romulus-emanuel.ruja@tutanota.com)**
        
        ## License
        
        This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Platform: UNKNOWN
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Requires-Python: >=3.6
Description-Content-Type: text/markdown
