"driver/driver.cpp" did not exist on "498e71b09822406b1b050c5eb03edebfe04038a6"
Commit b573f066 authored by Jonas Kaufmann's avatar Jonas Kaufmann Committed by Antoine Kaufmann
Browse files

README: tweak Quick Start intro and SimBricks Usage Examples

parent f6c6ff66
...@@ -36,12 +36,12 @@ Currently, SimBricks includes the following simulators: ...@@ -36,12 +36,12 @@ Currently, SimBricks includes the following simulators:
## Quick Start ## Quick Start
Depending on how you plan to use SimBricks, there are different ways to start Depending on how you plan to use SimBricks, there are different ways to start.
using it. The quickest way to get started just running SimBricks is with our The quickest way to just run something with SimBricks is through our [usage
[pre-built Docker container images](https://hub.docker.com/u/simbricks). examples](https://github.com/simbricks/simbricks-examples). However, if you plan
However, if you plan to make changes to SimBricks, you will have to build to make changes to SimBricks, you will have to build SimBricks from source,
SimBricks from source, either through Docker, or on your local machine. The either through Docker, or on your local machine. The different ways are listed
different ways are listed below in order of increasing effort required. below in order of increasing effort required.
**Please refer to **Please refer to
[our documentation](https://simbricks.readthedocs.io/en/latest/) for more [our documentation](https://simbricks.readthedocs.io/en/latest/) for more
...@@ -51,24 +51,23 @@ details.** ...@@ -51,24 +51,23 @@ details.**
**This is the quickest way to get started using SimBricks.** **This is the quickest way to get started using SimBricks.**
We provide a [repository](https://github.com/simbricks/simbricks-examples) We provide a [repository](https://github.com/simbricks/simbricks-examples) that
that contains a series of examples including an easy-to-use and more interactive contains a series of examples including an easy-to-use and more interactive
introduction to SimBricks through a Jupyter Notebook showing first steps on how to orchestrate introduction to SimBricks through a Jupyter Notebook, showing first steps on how
and run simulations using SimBricks. The repository is set up for usage to orchestrate and run simulations using SimBricks. The repository supports
with [GitHub codespaces](https://github.com/codespaces/new/simbricks/simbricks-examples/?quickstart=1) directly running the interactive example together with small tweaks directly
which in conjunction with the Jupyter Notebook provide a very easy to use step-by-step introduction from browser through [GitHub
to SimBricks. codespaces](https://github.com/codespaces/new/simbricks/simbricks-examples/?quickstart=1).
For more advanced use-cases the repository provides an example for users For more advanced use-cases, there's also an example on how to build custom disk
on how one can provide custom disk images to simulated SimBricks hosts for non-trivial images for simulated SimBricks hosts and a project on custom hardware
use-cases, and a project on hardware acceleration composed of several milestones development, composed of several milestones highlighting how SimBricks can be
guiding users through a complete SimBricks based development flow. used throughout the complete product cycle. You can use these as the basis to
build your own experiments. For that, the repository also comes with a dev
The repository is set up with a dev container configuration that makes running the container configuration that makes running the examples a breeze. The easiest
examples a breeze. For quick tests you can just open the repo in CodeSpaces. The way to use this locally is with [VS Code](https://code.visualstudio.com/) and
easiest way to use this locally is with vscode and its Dev Containers Extension. You can its [Dev Containers
find more details on how to use the provided experiments in the repositories extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
[README](https://github.com/simbricks/simbricks-examples/blob/main/README.md).
### Using Pre-Built Docker Images ### Using Pre-Built Docker Images
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment