Remove misleading info from README and add local dev instructions
What does this MR do?
Updates the README to remove misleading/outdated setup information. Also adds comprehensive instructions on running, debugging, and testing the analyser locally.
The instructions are expressed generically in the hopes that we can extract this into a common README suitable for all analysers.
What are the relevant issue numbers?
- Continuation of gitlab-org/gitlab#417573 (closed)
- Prerequisite of gitlab-org/gitlab#419042 (closed)
Does this MR meet the acceptance criteria?
-
Changelog entry added -
Documentation created/updated for GitLab EE, if necessary -
Documentation created/updated for this project, if necessary -
Documentation reviewed by technical writer or follow-up review issue created -
Tests updated/added for this feature/bug -
Job definition updated, if necessary -
Conforms to the code review guidelines -
Conforms to the Go guidelines -
Security reports checked/validated by reviewer
Edited by James Liu