Build C-Lang Makefile

Copies and customizes Makefile script to target path

---

• ⬆️ Top of Document

• 🏗️ Requirements

• ⚡ Quick Start

• 🧰 Usage

• 🗒 Notes

• 📈 Contributing

  • 🔱 Forking
  • 💱 Sponsor

• 📇 Attribution

• ⚖️ Licensing

---

Requirements

Bash version 4.4 or greater is required for build-clang-makefile script, and dependencies.

GAwk version 4.1 or greater is required for some features of built Makefiles to function.

---

Quick Start

Clone this project...

mkdir -vp ~/git/hub/clang-utilities

cd ~/git/hub/clang-utilities

git clone --recurse-submodules git@github.com:clang-utilities/build-clang-makefile.git

Install via make...

cd ~/git/hub/clang-utilities/build-clang-makefile

make install

Updates or upgrades are also facilitated via make commands...

cd ~/git/hub/clang-utilities/build-clang-makefile

make upgrade

---

Usage

After installation make a directory for C-Lang new plugin project...

mkdir -p ~/git/hub/clang-utilities/project-name

Run build-clang-makefile script for new project...

build-clang-makefile --path ~/git/hub/clang-utilities/project-name\
                     --author "S0AndS0"\
                     --version "0.0.1"

Documentation is available via --help command-line option...

build-clang-makefile --help

... or man may be used too...

man build-clang-makefile

---

Notes

This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.

---

Contributing

Options for contributing to build-clang-makefile and clang-utilities

---

Forking

Start making a Fork of this repository to an account that you have write permissions for.

• Add remote for fork URL. The URL syntax is git@github.com:<NAME>/<REPO>.git...

cd ~/git/hub/clang-utilities/build-clang-makefile

git remote add fork git@github.com:<NAME>/build-clang-makefile.git

• Commit your changes and push to your fork, eg. to fix an issue...

cd ~/git/hub/clang-utilities/build-clang-makefile


git commit -F- <<'EOF'
:bug: Fixes #42 Issue


**Edits**


- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF


git push fork main

Note, the -u option may be used to set fork as the default remote, eg. git push -u fork main however, this will also default the fork remote for pulling from too! Meaning that pulling updates from origin must be done explicitly, eg. git pull origin main

• Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>

Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.

---

Sponsor

Thanks for even considering it!

Via Liberapay you may on a repeating basis.

Regardless of if you're able to financially support projects such as build-clang-makefile that clang-utilities maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.

---

Attribution

• GitHub -- github-utilities/make-readme

---

License

Copies and customizes Makefile script to target path
Copyright (C) 2021 S0AndS0

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

For further details review full length version of AGPL-3.0 License.