Add README.md, LICENSE
This commit is contained in:
parent
d30a792aca
commit
2ea40ebe8d
2 changed files with 43 additions and 0 deletions
21
LICENSE
Normal file
21
LICENSE
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2020 Stephen Seo
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
22
README.md
Normal file
22
README.md
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
# Triangles
|
||||||
|
|
||||||
|
THIS PROJECT IS STILL A WORK IN PROGRESS!
|
||||||
|
|
||||||
|
A gui application that lets you draw triangles of different colors on a colored
|
||||||
|
background.
|
||||||
|
|
||||||
|
Uses [imgui](https://github.com/ocornut/imgui) for UI.
|
||||||
|
|
||||||
|
# Compiling
|
||||||
|
|
||||||
|
Create a build dir, run cmake, and then make to build.
|
||||||
|
|
||||||
|
mkdir buildDebug
|
||||||
|
cd buildDebug
|
||||||
|
cmake ..
|
||||||
|
make
|
||||||
|
|
||||||
|
## Dependencies
|
||||||
|
|
||||||
|
SFML should be installed on the system. imgui, and imgui-sfml are git submodules
|
||||||
|
and should be initialized with `git submodule update --init --recursive`.
|
Loading…
Reference in a new issue