Initial Vexta Core v0.1.0 release

test/lint/README.md

@@ -0,0 +1,43 @@
+This folder contains lint scripts.
+
+check-doc.py
+============
+Check for missing documentation of command line options.
+
+commit-script-check.sh
+======================
+Verification of [scripted diffs](/doc/developer-notes.md#scripted-diffs).
+Scripted diffs are only assumed to run on the latest LTS release of Ubuntu. Running them on other operating systems
+might require installing GNU tools, such as GNU sed.
+
+git-subtree-check.sh
+====================
+Run this script from the root of the repository to verify that a subtree matches the contents of
+the commit it claims to have been updated to.
+
+```
+Usage: test/lint/git-subtree-check.sh [-r] DIR [COMMIT]
+       test/lint/git-subtree-check.sh -?
+```
+
+- `DIR` is the prefix within the repository to check.
+- `COMMIT` is the commit to check, if it is not provided, HEAD will be used.
+- `-r` checks that subtree commit is present in repository.
+
+To do a full check with `-r`, make sure that you have fetched the upstream repository branch in which the subtree is
+maintained:
+* for `src/secp256k1`: https://github.com/digibyte-core/secp256k1.git (branch master)
+* for `src/leveldb`: https://github.com/digibyte-core/leveldb.git (branch digibyte-fork)
+* for `src/univalue`: https://github.com/digibyte-core/univalue.git (branch master)
+* for `src/crypto/ctaes`: https://github.com/digibyte-core/ctaes.git (branch master)
+* for `src/crc32c`: https://github.com/google/crc32c.git (branch master)
+
+To do so, add the upstream repository as remote:
+
+```
+git remote add --fetch secp256k1 https://github.com/digibyte-core/secp256k1.git
+```
+
+lint-all.sh
+===========
+Calls other scripts with the `lint-` prefix.