https://github.com/seqan/library-template
WIP
https://github.com/seqan/library-template
Last synced: 3 months ago
JSON representation
WIP
- Host: GitHub
- URL: https://github.com/seqan/library-template
- Owner: seqan
- License: other
- Created: 2023-02-07T10:46:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-08T10:30:57.000Z (over 3 years ago)
- Last Synced: 2025-01-13T12:23:54.154Z (over 1 year ago)
- Language: CMake
- Size: 163 KB
- Stars: 1
- Watchers: 6
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Library_Template
[![build status][1]][2]
[![codecov][3]][4]
[![license][5]][6]
[![latest release][7]][8]
![platforms][9]
[1]: https://img.shields.io/github/actions/workflow/status/seqan/library-template/ci_linux.yml?branch=main&style=flat&logo=github&label=CI "Open GitHub actions page"
[2]: https://github.com/seqan/library-template/actions?query=branch%3Amain
[3]: https://codecov.io/gh/seqan/library-template/branch/main/graph/badge.svg?token=BH1FQiBBle "Open Codecov page"
[4]: https://codecov.io/gh/seqan/library-template
[5]: https://img.shields.io/badge/license-BSD-green.svg "Open Copyright page"
[6]: https://github.com/seqan/library-template/blob/main/LICENSE.md
[7]: https://img.shields.io/github/release/seqan/library-template.svg "Get the latest release"
[8]: https://github.com/seqan/library-template/releases/latest
[9]: https://img.shields.io/badge/platform-linux%20%7C%20bsd%20%7C%20osx-informational.svg
## Quick start
You may want to replace `LIBRARY_TEMPLATE` with your library name:
```bash
# Rename files
find $(pwd) -type f -not -path '*/\.git/*' -iname "library_template*" -exec bash -c 'mv $1 ${1/library_template/}' bash {} \;
# Rename directories
find $(pwd) -type d -not -path '*/\.git/*' -iname "library_template*" -exec bash -c 'mv $1 ${1/library_template/}' bash {} \;
# Rename occurrences in files
find $(pwd) -type f -not -path '*/\.git/*' -exec sed -i 's/LIBRARY_TEMPLATE//g' {} \;
find $(pwd) -type f -not -path '*/\.git/*' -exec sed -i 's/Library_Template//g' {} \;
find $(pwd) -type f -not -path '*/\.git/*' -exec sed -i 's/library_template//g' {} \;
# Rename URLs
find $(pwd) -type f -not -path '*/\.git/*' -exec sed -i 's/seqan\/library-template/\//g' {} \;
```
## Updating
Pull history of the template:
```bash
git remote add template https://github.com/seqan/library-template
git fetch template
git rebase --onto template/main SHA_of_first_commit_in_your_repo main
# e.g. `git rebase --onto template/main 45a5e1dce4b440fc64fd1cd8d96c0370053b985a main`
```
The first commit is usually the one where you update all the names.
After this, `git merge template/main` can be used to merge changes.
## Sponsorships
[](https://vercel.com/?utm_source=seqan&utm_campaign=oss)
Vercel is kind enough to sponsor our documentation preview-builds within our pull requests. Check them out!