mrsh: Add information to README for LSP users. v1 REJECTED

Andrew Paon: 1
 Add information to README for LSP users.

 2 files changed, 12 insertions(+), 0 deletions(-)
#844747 alpine.yml success
#844748 archlinux.yml success
#844749 freebsd.yml success
Export patchset (mbox)
How do I use this?

Copy & paste the following snippet into your terminal to import this patchset into git:

curl -s https://lists.sr.ht/~emersion/mrsh-dev/patches/35320/mbox | git am -3
Learn more about email & git

[PATCH mrsh] Add information to README for LSP users. Export this patch

This command generates a file called `compile_commands.json`, which I
added to gitignore. Also ignored `.cache/clangd`, which gets populated
when I run my editor

It took me some time to figure out how to make LSP happy in this repo;
hopefully this information is helpful to others.

 .gitignore |  2 ++
 README.md  | 10 ++++++++++
 2 files changed, 12 insertions(+)

diff --git a/.gitignore b/.gitignore
index f269464..0bfc1a1 100644
--- a/.gitignore
+++ b/.gitignore
@@ -57,3 +57,5 @@ dkms.conf
diff --git a/README.md b/README.md
index 3287c4f..3fefdc4 100644
--- a/README.md
+++ b/README.md
@@ -24,6 +24,16 @@ To use POSIX make:

[Clangd](https://clangd.llvm.org/) users can use
from LLVM to generate the compilation database. This is necessary for LSP
clients to resolve references to `<mrsh/xyz.h>` libraries.

    make clean # intercept-build needs to build all objects
    intercept-build make

## Contributing

Either [send GitHub pull requests][GitHub] or [send patches on the mailing
mrsh/patches: SUCCESS in 1m19s

[Add information to README for LSP users.][0] from [Andrew Paon][1]

[0]: https://lists.sr.ht/~emersion/mrsh-dev/patches/35320
[1]: mailto:andrew@paon.wtf

✓ #844749 SUCCESS mrsh/patches/freebsd.yml   https://builds.sr.ht/~emersion/job/844749
✓ #844747 SUCCESS mrsh/patches/alpine.yml    https://builds.sr.ht/~emersion/job/844747
✓ #844748 SUCCESS mrsh/patches/archlinux.yml https://builds.sr.ht/~emersion/job/844748
Sorry, but I'd rather not add tooling-specific instructions in README.