aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md87
1 files changed, 87 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..646d783
--- /dev/null
+++ b/README.md
@@ -0,0 +1,87 @@
+# IMPL
+
+Version 0.1.0
+
+## Description
+
+A C project created with the gcli-style build system.
+
+## Building
+
+### Dependencies
+
+Required:
+- C11 compiler (gcc or clang)
+- make
+
+### Build Instructions
+
+```bash
+./configure
+make
+```
+
+### Debug Build
+
+```bash
+./configure --debug
+make
+```
+
+### Out-of-tree builds (optional)
+
+You can also build in a separate directory:
+
+```bash
+mkdir build
+cd build
+../configure
+make
+```
+
+### Installation
+
+```bash
+sudo make install
+```
+
+Default prefix is `/usr/local`. To change:
+
+```bash
+./configure --prefix=/usr
+```
+
+## Testing
+
+```bash
+make check
+```
+
+## IDE Support
+
+### clangd / LSP
+
+To generate `compile_commands.json` for clangd, use one of these methods:
+
+**Option 1: Using compiledb (recommended)**
+```bash
+pip install compiledb
+compiledb make
+```
+
+**Option 2: Using bear**
+```bash
+bear -- make
+```
+
+If the file is empty, try a clean build:
+```bash
+make clean
+bear -- make
+```
+
+## Usage
+
+```bash
+./impl
+```