Skip to content

Commit 74df22a

Browse files
authored
Initial commit
0 parents  commit 74df22a

File tree

4 files changed

+107
-0
lines changed

4 files changed

+107
-0
lines changed

β€Ž.github/workflows/docs.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: docs
2+
on:
3+
push:
4+
tags:
5+
- '*.*.*'
6+
# branches:
7+
# - main
8+
env:
9+
nim-version: 'stable'
10+
nim-src: src/${{ github.event.repository.name }}.nim
11+
deploy-dir: .gh-pages
12+
jobs:
13+
docs:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v3
17+
- uses: jiro4989/setup-nim-action@v1
18+
with:
19+
nim-version: ${{ env.nim-version }}
20+
- run: nimble install -Y
21+
- run: nim doc --index:on --project --path:. --out:${{ env.deploy-dir }} ${{ env.nim-src }}
22+
23+
- name: "Rename to index.html"
24+
run: mv ${{ env.deploy-dir }}/${{ github.event.repository.name }}.html ${{ env.deploy-dir }}/index.html
25+
26+
- name: "Find and replace (index.html)"
27+
run: sed -i 's/${{ github.event.repository.name }}.html/index.html/g' ${{ env.deploy-dir }}/index.html
28+
29+
# - name: "Find and replace (idx)"
30+
# run: sed -i 's/${{ github.event.repository.name }}.html/index.html/g' ${{ env.deploy-dir }}/${{ github.event.repository.name }}.idx
31+
32+
- name: "Find and replace (theindex.html)"
33+
run: sed -i 's/${{ github.event.repository.name }}.html/index.html/g' ${{ env.deploy-dir }}/theindex.html
34+
35+
- name: Deploy documents
36+
uses: peaceiris/actions-gh-pages@v3
37+
with:
38+
github_token: ${{ secrets.GITHUB_TOKEN }}
39+
publish_dir: ${{ env.deploy-dir }}

β€Ž.github/workflows/test.yml

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: test
2+
on:
3+
push:
4+
paths-ignore:
5+
- LICENSE
6+
- README.*
7+
- examples
8+
- .github/workflows
9+
pull_request:
10+
paths-ignore:
11+
- LICENSE
12+
- README.*
13+
- examples
14+
- .github/workflows
15+
jobs:
16+
test:
17+
runs-on: ubuntu-latest
18+
strategy:
19+
matrix:
20+
nim-version:
21+
- 'stable'
22+
steps:
23+
- uses: actions/checkout@v3
24+
- uses: jiro4989/setup-nim-action@v1
25+
with:
26+
nim-version: ${{ matrix.nim-version }}
27+
repo-token: ${{ secrets.GITHUB_TOKEN }}
28+
- run: nimble install -Y
29+
- run: nim c -r src/${{ github.event.repository.name }}.nim
30+
- run: nimble test

β€Ž.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.DS_Store
2+
nimcache/
3+
nimblecache/
4+
htmldocs/
5+
testresults/
6+
/tests/*
7+
!/tests/*.nim
8+
!/tests/*.nims

β€ŽREADME.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<p align="center">
2+
<img src="https://github.com/openpeeps/PKG/blob/main/.github/logo.png" width="90px"><br>
3+
OpenPeeps repository template for developing libraries,<br>projects and other cool things. πŸ‘‘ Written in Nim language
4+
</p>
5+
6+
<p align="center">
7+
<code>nimble install {PKG}</code>
8+
</p>
9+
10+
<p align="center">
11+
<a href="https://github.com/">API reference</a><br>
12+
<img src="https://github.com/openpeeps/pistachio/workflows/test/badge.svg" alt="Github Actions"> <img src="https://github.com/openpeeps/pistachio/workflows/docs/badge.svg" alt="Github Actions">
13+
</p>
14+
15+
## 😍 Key Features
16+
- [x] Open Source | `MIT` License
17+
- [x] Written in Nim language
18+
19+
## Examples
20+
...
21+
22+
### ❀ Contributions & Support
23+
- πŸ› Found a bug? [Create a new Issue](/issues)
24+
- πŸ‘‹ Wanna help? [Fork it!](/fork)
25+
- 😎 [Get €20 in cloud credits from Hetzner](https://hetzner.cloud/?ref=Hm0mYGM9NxZ4)
26+
- πŸ₯° [Donate via PayPal address](https://www.paypal.com/donate/?hosted_button_id=RJK3ZTDWPL55C)
27+
28+
### 🎩 License
29+
{PKG} | MIT license. [Made by Humans from OpenPeeps](https://github.com/openpeeps).<br>
30+
Copyright &copy; 2025 OpenPeeps & Contributors &mdash; All rights reserved.

0 commit comments

Comments
Β (0)