diff --git a/.imgs/icon.png b/.imgs/icon.png new file mode 100644 index 0000000..70173e2 Binary files /dev/null and b/.imgs/icon.png differ diff --git a/CMakeLists.txt b/CMakeLists.txt index e7e404f..28e4d34 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.25) -project(ssts C) +project(gravity C) set(SOURCE_FILES main.c) set(HEADER_FILES ) @@ -12,7 +12,7 @@ add_custom_target(assets ALL ${PROJECT_BINARY_DIR}/assets COMMENT "Copying assets to build folder") -add_dependencies(ssts assets) +add_dependencies(gravity assets) # We need a CMAKE_DIR with some code to find external dependencies set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/") @@ -25,4 +25,4 @@ find_package(assimp REQUIRED) find_package(cglm REQUIRED) include_directories(${PROJECT_NAME} ${OPENGL_INCLUDE_DIRS} ${GLUT_INCLUDE_DIRS} ${GLEW_INCLUDE_DIRS} ${ASSIMP_INCLUDE_DIRS} ${CGLM_INCLUDE_DIRS}) -target_link_libraries(${PROJECT_NAME} ${OPENGL_LIBRARIES} ${GLUT_LIBRARIES} ${GLEW_LIBRARIES} ${ASSIMP_LIBRARIES} ${CGLM_LIBRARIES} m) \ No newline at end of file +target_link_libraries(${PROJECT_NAME} ${OPENGL_LIBRARIES} ${GLUT_LIBRARIES} ${GLEW_LIBRARIES} ${ASSIMP_LIBRARIES} ${CGLM_LIBRARIES} m) diff --git a/README b/README deleted file mode 100644 index e69de29..0000000 diff --git a/README.md b/README.md new file mode 100644 index 0000000..9fbd42d --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ + +
+ +
+ +# Gravity + +--- + +Pet project simulator for interactions between matter built off of OpenGL and C. + +Goals and features: +- [x] Law of gravitation +- [x] Object tracing + - [ ] Toggle object tracing +- [ ] Grid + - [ ] Toggle Grid +- [ ] File format for importing scenes +- [ ] Collision +- [ ] Soft-bodies and structures + +## Installation + +Gravity uses CMake as its build automation system. To download and run gravity, please follow these steps: +- Clone the repository `git clone https://github.com/0xdeadbeer/gravity` +- Create a build directory `mkdir build` +- Go into the build directory `cd build` +- Generate build files `cmake ..` +- Compile project `make all` +- Run `./gravity` +- Enjoy + +## Contributions + +We highly encourage playing around with the software and contributing to the project. +Before opening a pull request, the contributor is expected to open an issue in which they thoroughly describe the issue (or feature) they're solving (or implementing). + +## License + +Gravity is licensed under the GPL-3.0 license. See the `LICENSE` file for more information. \ No newline at end of file