vieter-v
/
vieter
2
1
Fork 5
Code Issues 84 Pull Requests 4 Packages Projects Releases 12 Wiki Activity

Added docs command & notice in README [CI SKIP]

Jef Roosens 2022-04-29 10:34:12 +02:00
parent 488a172586
commit ed02d82a0d
Signed by: Jef Roosens
GPG Key ID: B75D4F293C7052DB
3 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -23,3 +23,6 @@ v/
# gdb log file # gdb log file
gdb.txt gdb.txt
# Generated docs
_docs/

8
Makefile
View File

@ -75,8 +75,14 @@ v/v:
git clone --single-branch https://git.rustybever.be/Chewing_Bever/v v git clone --single-branch https://git.rustybever.be/Chewing_Bever/v v
make -C v make -C v
.PHONY: clean
clean: clean:
rm -rf 'data' 'vieter' 'dvieter' 'pvieter' 'vieter.c' 'dvieterctl' 'vieterctl' 'pkg' 'src/vieter' *.pkg.tar.zst 'suvieter' 'afvieter' rm -rf 'data' 'vieter' 'dvieter' 'pvieter' 'vieter.c' 'dvieterctl' 'vieterctl' 'pkg' 'src/vieter' *.pkg.tar.zst 'suvieter' 'afvieter' '$(SRC_DIR)/_docs'
.PHONY: docs
docs:
rm -rf '$(SRC_DIR)/_docs'
cd '$(SRC_DIR)' && v doc -all -f html -m -readme .
# =====EXPERIMENTAL===== # =====EXPERIMENTAL=====

4
README.md
View File

@ -2,7 +2,9 @@
## Documentation ## Documentation
I host documentation for Vieter over at https://rustybever.be/docs/vieter/. I host documentation for Vieter over at https://rustybever.be/docs/vieter/. API
documentation for the current codebase can be found at
https://rustybever.be/api-docs/vieter/.
## Overview ## Overview