README.org: formatting; add some more notes

- Added notes for `rtags-include-file` and
  `rtags-get-include-file-for-symbol`.
- Added some notes how to get lua and compile rtags with lua enabled.

[ci skip]