forked from vieter-v/vieter
docs: added docs command & notice in README
parent
5287067ea7
commit
11ac3c0470
|
@ -23,3 +23,6 @@ v/
|
|||
|
||||
# gdb log file
|
||||
gdb.txt
|
||||
|
||||
# Generated docs
|
||||
_docs/
|
||||
|
|
8
Makefile
8
Makefile
|
@ -74,8 +74,14 @@ v/v:
|
|||
git clone --single-branch https://git.rustybever.be/Chewing_Bever/v v
|
||||
make -C v
|
||||
|
||||
.PHONY: 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=====
|
||||
|
|
|
@ -2,7 +2,9 @@
|
|||
|
||||
## 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
|
||||
|
||||
|
|
Loading…
Reference in New Issue