Skip to content

Commit 447beb0

Browse files
authored
Merge pull request #345 from lasp/feature/update-readme
Update readme
2 parents 8ecee12 + a539c5e commit 447beb0

File tree

1 file changed

+13
-24
lines changed

1 file changed

+13
-24
lines changed

README.md

+13-24
Original file line numberDiff line numberDiff line change
@@ -2,47 +2,36 @@
22

33
### Basilisk
44

5-
* [Summary of Basilisk](http://hanspeterschaub.info/basilisk/index.html)
6-
* [Versions](http://hanspeterschaub.info/basilisk/Support/bskReleaseNotes.html)
5+
* [Summary of Basilisk](docs/source/index.rst)
76

87
### How do I get set up?
98
The following links contain installation instructions for the supported platforms:
109

11-
- [Setup a macOS Development Environment](http://hanspeterschaub.info/basilisk/Install/installOnMacOS.html)
10+
- [Setup a macOS Development Environment](docs/source/Install/installOnMacOS.rst)
1211

13-
- [Setup a Linux Development Environment](http://hanspeterschaub.info/basilisk/Install/installOnLinux.html)
12+
- [Setup a Linux Development Environment](docs/source/Install/installOnLinux.rst)
1413

15-
- [Setup a Windows Development Environment](http://hanspeterschaub.info/basilisk/Install/installOnWindows.html)
14+
- [Setup a Windows Development Environment](docs/source/Install/installOnWindows.rst)
1615

1716

1817

1918
### Basilisk Development guidelines
20-
21-
* [Coding Guidelines](http://hanspeterschaub.info/basilisk/Support/Developer/CodingGuidlines.html)
19+
* [Contributing](CONTRIBUTING.md)
20+
* [Coding Guidelines](docs/source/Support/Developer/CodingGuidlines.rst)
2221

2322

2423
### Getting Started
25-
To get started with Basilisk (BSK), several tutorial python files are provided in the installed package. Within this
26-
web page documentation site, they are listed and discussed in the <a href="modules.html">Manual</a> tab. The
27-
documentation lists the scenarios in an order that facilitates learning basic BSK features. In the source code they
24+
To get started with Basilisk, several tutorials are provided. The
25+
documentation lists the scenarios in an order that facilitates learning basic Basilisk features. In the source code they
2826
are stored under `src\examples\`. A good start would be to run `scenarioBasicOrbit.py`.
2927

30-
To play with the tutorials, it is suggested the user makes a copy of these tutorial files, and use the copies in order
31-
to learn, test and experiment. To copy them, first find the location of the Basilisk installation. After installing,
32-
you can find the installed location of Basilisk by opening a python interpreter and running:
33-
34-
```
35-
import Basilisk
36-
basiliskPath = Basilisk.__path__[0]
37-
print(basiliskPath)
38-
```
28+
To run with the tutorials, it is suggested the user makes a copy of these tutorial files, and use the copies in order
29+
to learn, test and experiment. Copy the folder `{basiliskPath}/src/examples` into a new folder, and change to that
30+
directory.
3931

40-
Now copy the folder `{basiliskPath}/src/examples` into a new folder, and change to that directory.
41-
42-
To run the default scenario 1 of scenarioBasicOrbit, in the directory of the copied tutorials, call the python
32+
To run the default scenario of `scenarioBasicOrbit`, in the directory of the copied tutorials, execute the python
4333
script: `python3 scenarioBasicOrbit.py`
4434

45-
4635
Now, when you want to use a tutorial, navigate inside that folder, and edit and execute the *copied* integrated tests.
4736

4837
<!--Any new BSK module development should not occur within the BSK folder as this will be updated rapidly. Rather,
@@ -58,4 +47,4 @@ This is in development, but does provide a 3D view of many of the simulation sta
5847

5948
### Who do I talk to?
6049

61-
Questions and answers are fielded in the project's [Github Discussions](https://github.com/AVSLab/basilisk/discussions).
50+
Questions and answers are fielded in the project's [Github Discussions](https://github.com/lasp/basilisk/discussions).

0 commit comments

Comments
 (0)