Skip to content

Commit 2a707a7

Browse files
authored
Update ReadME
Moved codespaces button
1 parent cecaa53 commit 2a707a7

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,32 @@
2727
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"/></a>
2828
</p>
2929

30+
## What is BioDynaMo?
31+
32+
BioDynaMo is a software platform to easily create, run, and visualise 3D agent-based simulations.
33+
* **Blazing fast:** The core of the platform is written in C++ and is highly optimized to harness the computational power of modern hardware.
34+
* **Modular:** Reuse, adapt, or create modules that represents a specific biological behavior or entity. With BioDynaMo you don't need to start from scratch anymore!
35+
* **Visual:** Effortlessly create astonishing images and animations of your simulations. Your publications and presentations will stand out even more!
36+
37+
## Installation
38+
39+
Simply run the following command:
40+
41+
```
42+
curl https://biodynamo.github.io/install | bash
43+
```
44+
45+
For more information, check out our [user's guide](https://www.biodynamo.org/user-guide) documentation that is designed for people who will use BioDynaMo on a day-to-day basis, and aims at providing users with all essential info to make full use of BioDynaMo.
46+
47+
3048
## Try it online
3149

3250
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/BioDynaMo/biodynamoOnline)
3351

3452
Click the badge above to launch a pre-configured BioDynaMo environment in your browser.
3553
You just need a free GitHub account (120 core-hours/month free).
3654

55+
3756
### Quick start
3857

3958
Once the codespace loads, run a demo:
@@ -47,23 +66,6 @@ bdm view # opens ParaView on the VNC desktop
4766
A **VNC desktop** tab opens automatically in your browser (port 6080).
4867
ParaView and other GUI applications render there.
4968

50-
## What is BioDynaMo?
51-
52-
BioDynaMo is a software platform to easily create, run, and visualise 3D agent-based simulations.
53-
* **Blazing fast:** The core of the platform is written in C++ and is highly optimized to harness the computational power of modern hardware.
54-
* **Modular:** Reuse, adapt, or create modules that represents a specific biological behavior or entity. With BioDynaMo you don't need to start from scratch anymore!
55-
* **Visual:** Effortlessly create astonishing images and animations of your simulations. Your publications and presentations will stand out even more!
56-
57-
## Installation
58-
59-
Simply run the following command:
60-
61-
```
62-
curl https://biodynamo.github.io/install | bash
63-
```
64-
65-
For more information, check out our [user's guide](https://www.biodynamo.org/user-guide) documentation that is designed for people who will use BioDynaMo on a day-to-day basis, and aims at providing users with all essential info to make full use of BioDynaMo.
66-
6769
<!-- ## Examples
6870
-- Show some nice visualizations here, with a one-liner explanation -->
6971

0 commit comments

Comments
 (0)