diff --git a/README.md b/README.md index 04e59e0a20d17960165b25aca4790ff063421762..3ebb9464340d1a767ad2b709e02b6fa06d67c2c8 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,15 @@ contents is the following: - [ Grabber. ](#grabber) - [ System. ](#system) + + <a name="INP"></a> ## Implementing a new project In order to implement a new project, follow these steps: +0. Create a new folder in `projects`. + - Create subfolders `bin`, `include`, `lib` and `results` + - Copy the `lib` contents into `projects/newproj/lib` 1. Identify force on a single drum - Depends on static parameters (w, m, a, etc.) and dynamic parameters and variables (x, v, etc.). - Coupling and driving parameters are dynamic. @@ -47,6 +52,12 @@ for the dynamic matrix. 7. Check the unit tests (`unit_tests`) or other projects to see how a `main.cpp` could be constructed. +Hints for organizing and running simulations +1. Use a Makefile. + - The framework should be compiled with c++ 2a. +2. Organize executables in `bin` +3. Store data and plots in subfolders of `results` + <a name="Classes"></a>