https://github.com/jiro4989/repo-template-nim
Nim project template.
https://github.com/jiro4989/repo-template-nim
github-actions nim repository template
Last synced: 7 days ago
JSON representation
Nim project template.
- Host: GitHub
- URL: https://github.com/jiro4989/repo-template-nim
- Owner: jiro4989
- License: mit
- Created: 2020-03-01T12:41:39.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-09-03T21:07:16.000Z (8 months ago)
- Last Synced: 2025-03-31T17:50:48.944Z (about 2 months ago)
- Topics: github-actions, nim, repository, template
- Language: Nim
- Homepage:
- Size: 45.9 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
====
APPNAME
====
|nimble-version| |nimble-install| |gh-actions|
TODO
This is a Nim project template.
You must run command at first.
.. code-block:: shell
nim c tool/setup.nim
tool/setup --author: --appname:
This command replace and rename template strings of this repository.
.. contents:: Table of contents
Usage
=====
TODO
Installation
============
.. code-block:: shell
$ nimble install -Y APPNAME
LICENSE
=======
MIT
Development
===========
Release workflow
^^^^^^^^^^^^^^^^
GitHub Action runs when you pushed new tags.
.. code-block:: shell
$ git tag
$ git push origin
or
$ git push origin --tags
GitHub Action creates a new release and upload your assets.
Release workflows:
|image-release-workflow|
Release note will be generated by `git-chglog `_.
Config files are `.chglog <./.chglog>`_.
Details, see `release.yml <./.github/workflows/release.yml>`_.
.. |gh-actions| image:: https://github.com/jiro4989/APPNAME/workflows/test/badge.svg
:target: https://github.com/jiro4989/APPNAME/actions
.. |nimble-version| image:: https://nimble.directory/ci/badges/APPNAME/version.svg
:target: https://nimble.directory/ci/badges/APPNAME/nimdevel/output.html
.. |nimble-install| image:: https://nimble.directory/ci/badges/APPNAME/nimdevel/status.svg
:target: https://nimble.directory/ci/badges/APPNAME/nimdevel/output.html
.. |image-release-workflow| image:: https://user-images.githubusercontent.com/13825004/87944618-9897fc00-cada-11ea-9401-74167f04b5c4.png