From a20fa63067d6d506b59c853830997dfc7284547a Mon Sep 17 00:00:00 2001
From: i-ky <gl.ivanovsky@gmail.com>
Date: Wed, 5 Apr 2023 20:08:49 +0000
Subject: [PATCH] Add project description

---
 README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 62 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index cdbcac3..a9d7e7a 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,65 @@
 
 A tool that generates a
 [compilation database](https://clang.llvm.org/docs/JSONCompilationDatabase.html)
-for
-[clang](https://clang.llvm.org)
-tooling using
-[ptrace](https://en.wikipedia.org/wiki/Ptrace).
+for [clang] tooling using [ptrace] and [procfs].
+
+## summary
+
+If you are reading this
+you probably know what compilation database is
+and what it can be used for.
+And you are probably unlucky to use a build system
+that can't generate `compile_commands.json` for you.
+Your build system may even be especially non-cooperative
+defeating tools like [bear], [clade] and [compiledb].
+For example,
+build system may not respect injected `CC` and `CXX` environment variables,
+may hard-code compiler paths,
+may use statically linked binaries rendering `LD_PRELOAD` tricks useless
+or may not pass `make` flags recursively making build logs incomplete.
+There is however a less known [compile-db-gen],
+which uses [strace] to capture compiler invocations
+and should work even in these conditions.
+
+This project aims to improve on this idea:
+- to reduce overhead [ptrace] is used directly instead of [strace];
+- working directory, executable path and arguments are read from [procfs] reducing code complexity.
+
+## disclaimer
+
+It has been developed and tested on Linux.
+Whether it works on other systems is an open question.
+Your feedback (both positive and negative) is hihgly appreciated!
+
+## prerequisites
+
+You will need `make` and C++ compiler.
+
+## compile
+
+Simply:
+```bash
+make
+```
+It should produce `basset` executable in the project root directory.
+
+## install
+
+Copy `basset` executable to a desired location or create a symlink.
+
+## use
+
+A typical use would be:
+```
+basset -- <your-build-command>
+```
+Extra options can precede `--` if needed.
+
+[bear]: https://github.com/rizsotto/Bear
+[clade]: https://github.com/17451k/clade
+[clang]: https://clang.llvm.org
+[compile-db-gen]: https://github.com/sunlin7/compile-db-gen
+[compiledb]: https://github.com/nickdiego/compiledb
+[procfs]: https://en.wikipedia.org/wiki/Procfs
+[ptrace]: https://en.wikipedia.org/wiki/Ptrace
+[strace]: https://strace.io