From 77d7c2a4d06e4c0ba1c02d486a4ecf176f9fc830 Mon Sep 17 00:00:00 2001 From: Cat Flynn Date: Sat, 24 Aug 2024 12:38:56 +0100 Subject: [PATCH] docs: move instructions to README --- README.md | 43 ++++++++++++++++++++++++++++++++++++++++++- src/main.cpp | 36 ------------------------------------ 2 files changed, 42 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 4153633..4272a5b 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,49 @@ 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. +# 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 . + diff --git a/src/main.cpp b/src/main.cpp index 89937cc..0a89382 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -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 #include