Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme #147

Merged
merged 1 commit into from
Nov 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<h1 align="center">
<a href="https://github.com/hpc-maths/samurai">
<picture>
<source media="(prefers-color-scheme: dark)" height="200" srcset="./doc/source/logo/dark_logo.png">
<img alt="Text changing depending on mode. Light: 'So light!' Dark: 'So dark!'" height=200 src="./doc/source/logo/light_logo.png">
<source media="(prefers-color-scheme: dark)" height="200" srcset="./docs/source/logo/dark_logo.png">
<img alt="Text changing depending on mode. Light: 'So light!' Dark: 'So dark!'" height=200 src="./docs/source/logo/light_logo.png">
</picture>
</a>
</h1>
Expand Down Expand Up @@ -47,8 +47,6 @@ Samurai also offers a flexible and pleasant interface to easily implement numeri
- [Features](#features)
- [Installation](#installation)
- [From conda](#from-conda)
- [From vcpkg](#from-vcpkg)
- [From conan](#from-conan)
- [From source](#from-source)
- [Get help](#get-help)
- [Project assistance](#project-assistance)
Expand Down Expand Up @@ -219,15 +217,21 @@ The [tutorial](./demos/tutorial/) directory is a good first step followed by the

### From conda

Coming soon !
```bash
mamba install samurai
```

### From vcpkg
If you want to compile your scripts, you also have to install a C++ compiler and cmake.

Coming soon !
```bash
mamba install cxx-compiler cmake
```

### From conan
And finally, if you have to use PETSc to assemble the matrix of your problem, you need to install it

Coming soon !
```bash
mamba install petsc pkg-config
```

### From source

Expand Down