Add makefile targets for doc8 lint, fix formatting/spelling issues

Change-Id: I0f45ffe0ba94fab89f9b38c9b73ed7b9091f1795
9 files changed
tree: 9ea64acf789134247a6df9a2c0e682a10c270e93
  1. .dockerignore
  2. .gitignore
  3. .gitreview
  4. CODE_OF_CONDUCT.md
  5. Dockerfile.builder.dockerignore
  6. LICENSE.md
  7. Makefile
  8. README.md
  9. VERSION
  10. api/
  11. build/
  12. cmd/
  13. configs/
  14. docs/
  15. examples/
  16. go.mod
  17. go.sum
  18. internal/
  19. tests/
  20. tools/
  21. vendor/
README.md

BroadBand Simular (BBSim)

Build

BBSim is managed via a Makefile, plese run the following command to display all the available targets

make help

Documentation

More advanced documentation lives in here.

You can generate and browse the documentation by executing:

make docs

This project structure is based on golang-standards/project-layout.