Copies, and customizes, documentation file to target path
This repository makes use of Git Submodules to track dependencies, to avoid incomplete downloads clone with the --recurse-submodules
option...
git clone --recurse-submodules [email protected]:vim-utilities/build-vim-doc.git
To update tracked Git Submodules issue the following commands...
git pull
git submodule update --init --merge --recursive
To force upgrade of Git Submodules...
git submodule update --init --merge --recursive --remote
Note, forcing and update of Git Submodule tracked dependencies may cause instabilities and/or merge conflicts; if however everything operates as expected after an update please consider submitting a Pull Request.
Perhaps as easy as one, 2.0,...
Clone this project...
mkdir -vp ~/git/hub/vim-utilities
cd ~/git/hub/vim-utilities
git clone --recurse-submodules [email protected]:vim-utilities/build-vim-doc.git
Install via make install
command...
cd ~/git/hub/vim-utilities/build-vim-doc
make install
Uninstalled via make uninstall
target...
cd ~/git/hub/vim-utilities/build-vim-doc
make uninstall
... Which will remove script, tab-completion, and documentation symbolic links.
To update in the future use make upgrade
command...
cd ~/git/hub/vim-utilities/build-vim-doc
make upgrade
After installation, documentation may be accessed via Vim's man
command, eg...
man build-vim-doc
Make a directory for Vim new plugin project...
mkdir -p ~/git/hub/vim-utilities/project-name
Run build-vim-doc
script for new project...
build-vim-doc --path ~/git/hub/vim-utilities/project-name\
--name script-file.vim\
--mode Visual
--author S0AndS0\
--version 8.2
This repository may not be feature complete and/or fully functional, Pull Requests that add features or fix bugs are certainly welcomed.
Options for contributing to build-vim-doc and vim-utilities
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
[email protected]:<NAME>/<REPO>.git
...
cd ~/git/hub/vim-utilities/build-vim-doc
git remote add fork [email protected]:<NAME>/build-vim-doc.git
- Commit your changes and push to your fork, eg. to fix an issue...
cd ~/git/hub/vim-utilities/build-vim-doc
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 setfork
as the default remote, eg.git push -u fork main
however, this will also default thefork
remote for pulling from too! Meaning that pulling updates fromorigin
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.
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-vim-doc that vim-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.
Copies, and customizes, documentation file 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.