From bf7c0ee702ae9410a435747c9c7e3ac358e12a1f Mon Sep 17 00:00:00 2001
From: budchirp <budchirp@gmail.com>
Date: Sat, 11 May 2024 12:16:54 +0300
Subject: [PATCH] readme: add usage example

---
 .gitignore             | 19 +++++++++++++------
 .idea/.gitignore       |  8 ++++++++
 .idea/calcplusplus.iml |  2 ++
 .idea/misc.xml         |  4 ++++
 .idea/modules.xml      |  8 ++++++++
 .idea/vcs.xml          |  6 ++++++
 README.md              | 15 +++++++++------
 7 files changed, 50 insertions(+), 12 deletions(-)
 create mode 100644 .idea/.gitignore
 create mode 100644 .idea/calcplusplus.iml
 create mode 100644 .idea/misc.xml
 create mode 100644 .idea/modules.xml
 create mode 100644 .idea/vcs.xml

diff --git a/.gitignore b/.gitignore
index 5f77433..e34ffc0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -37,10 +37,6 @@ modules.order
 Module.symvers
 Mkfile.old
 dkms.conf
-.idea
-*.iml
-out
-gen
 .idea/**/workspace.xml
 .idea/**/tasks.xml
 .idea/**/usage.statistics.xml
@@ -59,7 +55,7 @@ gen
 .idea/**/libraries
 cmake-build-*/
 .idea/**/mongoSettings.xml
-*.iwss
+*.iws
 out/
 .idea_modules/
 atlassian-ide-plugin.xml
@@ -70,4 +66,15 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 .idea/httpRequests
-.idea/caches/build_file_checksums.ser
\ No newline at end of file
+.idea/caches/build_file_checksums.ser
+CMakeLists.txt.user
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps
diff --git a/.idea/.gitignore b/.idea/.gitignore
new file mode 100644
index 0000000..13566b8
--- /dev/null
+++ b/.idea/.gitignore
@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
diff --git a/.idea/calcplusplus.iml b/.idea/calcplusplus.iml
new file mode 100644
index 0000000..f08604b
--- /dev/null
+++ b/.idea/calcplusplus.iml
@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module classpath="CMake" type="CPP_MODULE" version="4" />
\ No newline at end of file
diff --git a/.idea/misc.xml b/.idea/misc.xml
new file mode 100644
index 0000000..79b3c94
--- /dev/null
+++ b/.idea/misc.xml
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="CMakeWorkspace" PROJECT_DIR="$PROJECT_DIR$" />
+</project>
\ No newline at end of file
diff --git a/.idea/modules.xml b/.idea/modules.xml
new file mode 100644
index 0000000..796e8dd
--- /dev/null
+++ b/.idea/modules.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/calcplusplus.iml" filepath="$PROJECT_DIR$/.idea/calcplusplus.iml" />
+    </modules>
+  </component>
+</project>
\ No newline at end of file
diff --git a/.idea/vcs.xml b/.idea/vcs.xml
new file mode 100644
index 0000000..35eb1dd
--- /dev/null
+++ b/.idea/vcs.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>
\ No newline at end of file
diff --git a/README.md b/README.md
index cdb36c8..7688400 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,11 @@
-<div align="center">
-  <h1>calcplusplus</h1>
-</div>
+<h1 align="center">calcplusplus</h1>
+<h2 align="center">TUI calculator written in C++ using FTXUI</h2>
 
-<p align="center">
+<div align="center">
   <img alt="Stargazers" src="https://img.shields.io/github/stars/budchirp/calcplusplus?style=for-the-badge&colorA=0b1221&colorB=ff8e8e" />
   <img alt="Last commit" src="https://img.shields.io/github/last-commit/budchirp/calcplusplus?style=for-the-badge&colorA=0b1221&colorB=BDB0E4" />
   <img alt="Issues" src="https://img.shields.io/github/issues/budchirp/calcplusplus?style=for-the-badge&colorA=0b1221&colorB=FBC19D" />
-</p>
+</div>
 
 
 ## 💾 Installation
@@ -14,7 +13,7 @@
 ### Requirements
 
 1. C compiler
-2. CMake
+2. CMake & Make
 
 ### How to install?
 
@@ -34,3 +33,7 @@ cmake ../ && make -j$(nproc)
 > NOTE: If you're using fish, remove the `$` sign.
 
 3. Have fun!
+
+```sh
+./build/calcplusplus
+```
\ No newline at end of file