Skip to content

Commit

Permalink
feat: add lines of code to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
aarondill committed Dec 7, 2024
1 parent d1de3d0 commit 00f5a4d
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/gen-readme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Generate README
on:
push:
pull_request:
paths:
- "README.md" # This isn't needed, but it's a good sanity check
- "README.tmpl.md"
workflow_dispatch:
jobs:
generate-readme:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@master
- run: |
printf '%s\n' "<!-- This file is generated from README.tmpl.md -->" > README.md
cat README.tmpl.md >> README.md
- name: CLOC
uses: djdefi/cloc-action@6
with:
options: --md --report-file=cloc.md --hide-rate
# Note: initial newline is required because files don't end with one
- run: |
printf '\n%s\n' '### Lines of code' >> README.md
cat cloc.md >> README.md
rm cloc.md
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: "chore: Generate README"
file_pattern: README.md
21 changes: 21 additions & 0 deletions README.tmpl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# NeoVim config

> ```
> In the realm of code, where minds ignite,
> NeoVim shines with its digital light.
> Commands whispered, keystrokes dance,
> Efficiency's ally, in every chance.
>
> Customized canvas, plugins adorn,
> Syntax and style, beautifully worn.
> Through the lines of text, journeys unfold,
> In NeoVim's embrace, stories untold.
> - ChatGPT
> ```
Feel free to take snippets with or without credit.\
No guarantees are made as to their functionality.\
Or lack therein.\
It works on my machine ¯\\\_(ツ)\_\/¯
> Please open an issue if something doesn't work. I'd love to make these dotfiles more universal.

0 comments on commit 00f5a4d

Please sign in to comment.