Skip to content

Commit

Permalink
add logo to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
atilafassina committed Aug 14, 2024
1 parent 6877c58 commit cb2eacc
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# Quantum

This template should help get you started developing with Tauri + SolidStart + TypeScript.
<div align="center">
<img src="/docs/quantum-dark-mode.svg#gh-dark-mode-only" width="250" />
<img src="/docs/quantum-dark-mode.svg#gh-light-mode-only" width="250" />
<h1>Quantum</h1>
<p>This template should help get you started developing with Tauri + SolidStart + TypeScript.</p>
</div>

> [!note]
> Tauri v2 is already considered stable, it is currently at the Release Candidate stage. This means only minor fixes are expected towards the stable release.
> Tauri v2 is already considered stable, it is currently at the **Release Candidate** stage. This means only minor fixes are expected towards the stable release.
## Cloning it 🐑

Expand All @@ -23,7 +26,7 @@ git clone --depth 1 https://github.com/atilafassina/quantum

The snippets below use [PNPM](https://pnpm.io) as the package manager and task runner, but Yarn, NPM, Bun, or Cargo should also work with the appropriate syntax.

> 🛟 Check the [Tauri Docs](https://beta.tauri.app/) for more guidance on building your app.
> 🛟 Check the [Tauri Docs](https://v2.tauri.app/) for more guidance on building your app.
First step is always to install JavaScript dependencies from the root:

Expand All @@ -43,7 +46,7 @@ pnpm tauri dev

<img src="/docs/ios.png" align="right" height="300"/>

[Check the prerequisites](https://beta.tauri.app/guides/prerequisites/#ios) for having iOS ready to run (MacOS only).
[Check the prerequisites](https://v2.tauri.app/guides/prerequisites/#ios) for having iOS ready to run (MacOS only).
Once that is done, let’s create the XCode project:

```sh
Expand All @@ -63,7 +66,7 @@ This command will open XCode with your project, select the simulator and get rea

<img src="/docs/android.png" align="right" height="300"/>

[Android Studio and a few other steps will be required](https://beta.tauri.app/guides/prerequisites/#android) to get things up and running.
[Android Studio and a few other steps will be required](https://v2.tauri.app/guides/prerequisites/#android) to get things up and running.
Once that's done, you can initialize the project:

```sh
Expand Down

0 comments on commit cb2eacc

Please sign in to comment.