Merge pull request #76 from HEPLean/Update-versions

docs: Add docs for scripts, update readme

README.md

@@ -17,12 +17,12 @@ A project to digitalize high energy physics.
 ## Areas of high energy physics with some coverage in HepLean
 
   
-[![](https://img.shields.io/badge/The_CKM_Matrix-blue)](https://heplean.github.io/HepLean/HepLean/FlavorPhysics/CKMMatrix/Basic.html)
-[![](https://img.shields.io/badge/Higgs_Field-blue)](https://heplean.github.io/HepLean/HepLean/StandardModel/HiggsBoson/Basic.html)
-[![](https://img.shields.io/badge/2HDM-blue)](https://heplean.github.io/HepLean/HepLean/BeyondTheStandardModel/TwoHDM/Basic.html)
-[![](https://img.shields.io/badge/Lorentz_Group-blue)](https://heplean.github.io/HepLean/HepLean/SpaceTime/LorentzGroup/Basic.html)
-[![](https://img.shields.io/badge/Anomaly_Cancellation-blue)](https://heplean.github.io/HepLean/HepLean/AnomalyCancellation/Basic.html)
-[![](https://img.shields.io/badge/Feynman_diagrams-blue)](https://heplean.github.io/HepLean/HepLean/FeynmanDiagrams/PhiFour/Basic.html)
+[![](https://img.shields.io/badge/The_CKM_Matrix-blue)](https://heplean.github.io/HepLean/docs/HepLean/FlavorPhysics/CKMMatrix/Basic.html)
+[![](https://img.shields.io/badge/Higgs_Field-blue)](https://heplean.github.io/HepLean/docs/HepLean/StandardModel/HiggsBoson/Basic.html)
+[![](https://img.shields.io/badge/2HDM-blue)](https://heplean.github.io/HepLean/docs/HepLean/BeyondTheStandardModel/TwoHDM/Basic.html)
+[![](https://img.shields.io/badge/Lorentz_Group-blue)](https://heplean.github.io/HepLean/docs/HepLean/SpaceTime/LorentzGroup/Basic.html)
+[![](https://img.shields.io/badge/Anomaly_Cancellation-blue)](https://heplean.github.io/HepLean/docs/HepLean/AnomalyCancellation/Basic.html)
+[![](https://img.shields.io/badge/Feynman_diagrams-blue)](https://heplean.github.io/HepLean/docs/HepLean/FeynmanDiagrams/PhiFour/Basic.html)
 ## Where to learn more 
 
 - Read the associated paper:

scripts/README.md

@@ -0,0 +1,58 @@
+
+# Scripts associated with HepLean 
+
+## lint-style.py and lint-style.sh
+
+Taken from Mathlib's linters. These perform text-based linting of the code. 
+
+These are to be slowly replaced with code written in Lean.
+
+## double_line_lint
+
+Checks for double empty lines in HepLean. 
+Passing this linter is currently not required to pass CI on github.
+
+Run using 
+```
+lake exe double_line_lint
+```
+
+## check_file_imports.lean 
+
+Checks all files are correctly imported into `HepLean.lean`. 
+
+Run using 
+```
+lake exe check_file_imports
+```
+
+## type_former_lint.lean
+
+Checks whether the name of definitions which form a type or prop starts with a capital letter. 
+
+Run using 
+```
+lake exe type_former_lint
+```
+
+## lint-all.sh 
+
+Performs all linting checks on HepLean. 
+
+Run using 
+```
+./scripts/lint-all.sh
+```
+
+## Other useful commands
+
+- To build HepLean use 
+```
+lake exe cache get 
+lake build
+```
+
+- To update HepLean's dependencies use 
+```
+lake update
+```

scripts/build.sh

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-
-
-
-lake exe cache get 
-lake build

scripts/update-lean-mathlib.sh

@@ -1,4 +0,0 @@
-#!/usr/bin/env bash
-
-lake update 
-