# Installation
Basic guide for graphite installation process via **Cmake and Bin** file. **After installation** you can use it from **command line**.









## TOC
- [Installation](#installation)
	- [TOC](#toc)
	- [Prerequisites](#prerequisites)
	- [Installation Command](#installation-command)
		- [via CMake](#via-cmake)
		- [via Binaries](#via-binaries)
	- [Running Graphite](#running-graphite)
		- [Run the application with:](#run-the-application-with)
		- [Use flags like](#use-flags-like)
	- [Troubleshooting](#troubleshooting)









## Prerequisites
- CMake
- g++ (C++17 or newer)
- Git
- OpenGL libraries









## Installation Command
### via CMake
```bash
git clone --recursive https://github.com/daynlight/Graphite.git 
										# clone with submodules

cd Graphite

mkdir -p build
cd build
cmake .. 								# configure cmake
cmake --build . --config Release	 	# build in Release
cd ..

cd bin/
sudo ./GraphiteInstaller				# Run Installer

cd ../..
```

### via Binaries
1. Install binaries file from release named [```<version>-bin```](https://github.com/Daynlight/Graphite/releases?q=bin&expanded=true).
2. Run ```GraphiteInstaller``` with sudo
```bash
sudo ./GraphiteInstaller
```









## Running Graphite
### Run the application with:
```bash
Graphite <flags> <path>
```

### Use flags like 
* `-h` - help.
* `-i` - init.
* `-s` - sandbox mode.
* `-v` - verbose modes.

[More Usage Information](https://github.com/Daynlight/Graphite/wiki/Usage)









## Troubleshooting
See [Troubleshooting.md](https://github.com/Daynlight/Graphite/wiki/Troubleshooting) for common issues and solutions.