Skip to content

Commit 4461d4c

Browse files
Move existing Install instructions to Build
1 parent 01d6211 commit 4461d4c

14 files changed

+20
-14
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Now, when you want to use a tutorial, navigate inside that folder, and edit and
3939

4040
Any new BSK module development should not occur within the BSK folder as this will be updated rapidly. Rather,
4141
new FSW algorithm or simulation code modules should be created in a custom folder outside of the BSK directory.
42-
See the [building custom modules](docs/source/Install/buildExtModules.rst) web page
42+
See the [building custom modules](docs/source/Build/buildExtModules.rst) web page
4343
for more information.
4444

4545
To use the standalone 3D Visualization, download the [Vizard](docs/source/Vizard/VizardDownload.rst).

docs/source/Build.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Build
2+
=====
3+
4+
.. toctree::
5+
:maxdepth: 1
6+
:caption: Contents:
7+
8+
Build/customPython
9+
Build/pullCloneBSK
10+
Build/installOnLinux
11+
Build/installOnMacOS
12+
Build/installOnWindows
13+
Build/installBuild
14+
Build/buildExtModules
15+
Build/installBuildConan
16+
Build/pipInstall
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Motivation
1111
----------
1212
.. sidebar:: Source Code
1313

14-
An example external folder with custom Basilisk modules and message definitions can be downloaded :download:`here </../../docs/source/Install/External.zip>`.
14+
An example external folder with custom Basilisk modules and message definitions can be downloaded :download:`here </../../docs/source/Build/External.zip>`.
1515

1616

1717
It is preferred that the user not put their own modules inside the official Basilisk folder unless this module is intended to be pushed back to the repository. This keeps the official Basilisk folder free from local customizations and thus easier to keep up to date. With Basilisk 2.0 and onwards the user has the ability to create modules which are not included in basilisk repository. The new build system allows a single folder containing custom BSK modules to be included into a single Basilisk build. This document outlines how this is done. The resulting build product will contain both the official Basilisk modules as well as modules available within this external folder.
@@ -70,5 +70,3 @@ Frequently Asked Questions
7070
- The custom Basilisk modules are built into a ``Basilisk.ExternalModules`` package. For example, to load a module called ``customCppModule``, use::
7171

7272
from Basilisk.ExternalModules import customCppModule
73-
74-
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)