AVSLab / basilisk

Astrodynamics simulation framework
https://hanspeterschaub.info/basilisk
ISC License
132 stars 63 forks source link

update documentation on installing and compiling Basilisk #437

Open schaubh opened 1 year ago

schaubh commented 1 year ago

Describe your use case The documentation page Install/Building the Software Framework needs to be updated and refactored. For example, we should

Describe alternatives solutions you've considered N/A

Additional context N/A

ephraim271 commented 9 months ago

add documentation that developers show not be compiling with python conanfile.py as this resets the messaging files each time and greatly increases the compile time. How to do this? Right now I compile everytime there's a change in a C Module.

schaubh commented 9 months ago

I fixed a typo in that bullet. If you run python conanfile.py, this deletes the already build messaging system, recreates interfaces for all messages.h files, and thus takes much longer to compile. This is a good step for a clean install, or when you add new message definitions that need to be integrated.

However, if you are just working on a module, I recommend compiling in Xcode or Visual Studio IDE. Then you get a much faster incremental build for the changed files, not a large rebuild of the large message system.