Skip to content
This repository has been archived by the owner on Apr 25, 2023. It is now read-only.

clean up the repo structure and structure the documentation #11

Closed
shrouxm opened this issue Sep 3, 2020 · 0 comments · Fixed by #16
Closed

clean up the repo structure and structure the documentation #11

shrouxm opened this issue Sep 3, 2020 · 0 comments · Fixed by #16
Assignees
Labels
documentation Improvements or additions to documentation team/code-intelligence
Milestone

Comments

@shrouxm
Copy link
Contributor

shrouxm commented Sep 3, 2020

the source should live in src, the README should contain the basics and link out to the following pieces of documentation (still in the README or standalone):

  • platform advice for compiling the tool
  • general tips for coaxing a compilation database to work for a project
  • runbooks of successful lsif indexes of popular OSS repos
@shrouxm shrouxm added documentation Improvements or additions to documentation team/code-intelligence labels Sep 3, 2020
@shrouxm shrouxm added this to the 3.20 milestone Sep 3, 2020
@shrouxm shrouxm self-assigned this Sep 3, 2020
@shrouxm shrouxm linked a pull request Sep 21, 2020 that will close this issue
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation team/code-intelligence
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant