ktyl
/
skein
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: move instructions to README

This commit is contained in:
Cat Flynn 2024-08-24 12:38:56 +01:00
parent a570986485
commit 77d7c2a4d0
2 changed files with 42 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -2,8 +2,49 @@
Skein is a library for efficiently simulating Keplerian astrodynamics. Skein is a library for efficiently simulating Keplerian astrodynamics.
## Usage ## Particles
Kepler models orbiting bodies as particles. Particles are zero-dimensional objects which can be on elliptical orbits around other particles. The orbited particle is assumed to make up the overwhelming majority of the mass of the combined two-object system. Kepler models orbiting bodies as particles. Particles are zero-dimensional objects which can be on elliptical orbits around other particles. The orbited particle is assumed to make up the overwhelming majority of the mass of the combined two-object system.
# Compiling
## Windows
Install GLFW 3.3.8
https://www.glfw.org/download.html
Install GLEW 2.2.0
https://github.com/nigels-com/glew/releases/tag/glew-2.2.0
extract the downloaded .zip files to "C:/libs"; this is currently expected
by our CMakeLists.txt.
Install CMake
https://cmake.org/download
Add to PATH for all users
from project root:
mkdir build
cd build
cmake ..
cmake --build .
The last step compiles the executable - this can also be done from Visual
Studio
### To run in VS
Set startup project in Solution Explorer
Press F5 to run
## To run in VSCode
https://code.visualstudio.com/docs/cpp/config-mingw
## Arch Linux
Install dependencies
sudo pacman -S glfw mesa glew
Build
cd build
cmake ..
cmake --build .

36
src/main.cpp
View File

@ -1,39 +1,3 @@
// To compile on Windows
// Install GLFW 3.3.8
// https://www.glfw.org/download.html
// Install GLEW 2.2.0
// https://github.com/nigels-com/glew/releases/tag/glew-2.2.0
//
// extract the downloaded .zip files to "C:/libs"; this is currently expected
// by our CMakeLists.txt.
// Install CMake
// https://cmake.org/download
// Add to PATH for all users
// from project root:
// mkdir build
// cd build
// cmake ..
// cmake --build .
// The last step compiles the executable - this can also be done from Visual
// Studio
// To run in VS
// Set startup project in Solution Explorer
// Press F5 to run
// To run in VSCode
// https://code.visualstudio.com/docs/cpp/config-mingw
// To compile on Arch Linux
//
// Install dependencies
// sudo pacman -S glfw mesa glew
//
// Build
// cmake ..
// cmake --build .
#include <GL/glew.h> #include <GL/glew.h>
#include <GLFW/glfw3.h> #include <GLFW/glfw3.h>