> For the complete documentation index, see [llms.txt](https://docs.codersky.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.codersky.net/cst/introduction.md).

# Introduction

CSkyTester, or CST for short, is a flexible test suite for C projects. It allows you to [create tests](/cst/creating-your-tests.md) within seconds and runs them in milliseconds.

CST has been designed with performance and ease of use in mind, and while it offers built-in tools like [crash detection](/cst/crash-detection.md), it is by no means a replacement to other tools such as [valgrind](/cst/running-cst.md#about-valgrind) or ASan. CST's goal is to provide tools to quickly test your project **without any dependencies**.

CST complies with the **GNU C99** standard (`-std=gnu99`), meaning it is based on **ISO C99** with GCC extensions and the GNU libc *(glibc)*. It requires only a C compiler such as GCC or Clang, and **no external dependencies**.

## Installing CST

CST provides an official Makefile to install it as a system library. You just have to clone the [repository](https://github.com/xDec0de/CSkyTester.git), enter the cloned directory, and run:

```bash
sudo make install
```

{% hint style="info" %}
Root privileges are required because CST installs its libraries under `/usr/local/lib` and `/usr/local/include`
{% endhint %}

That’s it. CST will be available **system-wide** and ready to link with `-lcst`.

Of course, you can just run `make`. This will generate the `libcst.a` and `libcst.so` files so you can link them manually if you prefer not to *(Or don’t have permission to)* perform a system-wide installation.

An alternative option to libraries is to add all `.c` files inside CST’s `src/` directory. This approach is described in detail [here](/cst/running-cst.md), as it is technically not an installation.

### Uninstalling

If for whatever reason you want to uninstall CST, you can run `sudo make uninstall` to remove the system-wide installation of CST, or `make clean` to remove all build artifacts.