From ace31427c341fa907dfa1dc0cde65991f96743a2 Mon Sep 17 00:00:00 2001
From: Timerix <timerix11@gmail.com>
Date: Fri, 12 Jul 2024 02:42:44 +0300
Subject: [PATCH] readme

---
 README.md | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index bb1f426..ccd7d45 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,23 @@
 # cbuild
 My C/C++ build system written in bash.
 
-Repo contains some functions, which can be used in your custom task scripts. There are also some default tasks.
 
-All tasks can be launched through `Makefile` or `cbuild/call_task.sh`. Tasks can be configured in `current.config`.
-
-## How to set up
+## Installation
 ```bash
-git clone https://timerix.ddns.net:3322/cbuild.git && \
-cbuild/setup.sh submodule
+git clone https://timerix.ddns.net:3322/cbuild.git
+cd cbuild
+sudo ./setup.sh 
 ```
-Than create your project `default.config` based on `cbuild/default.config`.
+
+## Usage
+1. Initialize cbuild project in some directory:
+    ```bash
+    cd some_project
+    cbuild --new-project
+    ```
+
+2. Edit `default.config`.
+3. Call some tasks:
+    ```bash
+    cbuild build_exec_dbg exec_dbg
+    ```