mirror of
https://github.com/status-im/nimbus-eth1.git
synced 2025-01-24 19:19:21 +00:00
de24b544c4
why:
* easy browsing of prototype docs, allows to follow links with
a web browser on the local file system
* some md & png files may contain additional documentation
overview:
* separate nimbus/makefile, try "make -C nimbus" for instructions
* running "make -C nimbus docs" will do the job
* x-ref file in nimbus/docs/theindex.html
* additional md and png files in nimbus/docs/ex/.. subdirectory
details:
* a newer nim compiler provides better referencing when available, in
particular the back link to the indices are not provided by the 1.2.10
nim compiler (automatically handled by makefile)
* make patterns are used to update files only when the timestamp changes
* should provide "discount" markdown generator, otherwise fallback
to <pre/> encapsulated text file
35 lines
488 B
Plaintext
35 lines
488 B
Plaintext
*~
|
|
|
|
# Executables shall be put in an ignored build/ directory
|
|
/build
|
|
|
|
# Nimble packages
|
|
/vendor/.nimble
|
|
|
|
# ntags/ctags output
|
|
/tags
|
|
|
|
# a symlink that can't be added to the repo because of Windows
|
|
/nimbus.nims
|
|
|
|
# Ignore dynamic, static libs and libtool archive files
|
|
*.so
|
|
*.dylib
|
|
*.a
|
|
*.la
|
|
*.exe
|
|
*.dll
|
|
|
|
# Ignore generated C and doc files
|
|
nimcache
|
|
/nimbus/docs
|
|
|
|
# Ignore test reports
|
|
VMTests.md
|
|
/newBlock[Cc]hainTests.md
|
|
/witnessBuilderBC.md
|
|
/witnessBuilderGST.md
|
|
|
|
/debug*.json
|
|
/block*.json
|