Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hiltontj committed Nov 19, 2023
1 parent f84ee61 commit 5f9d41d
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,28 +25,31 @@ Some basic options allow you to customize the view:
<img src="public/solars_options.gif" />
</div>

## Build
## Build & Development

Clone this repository to your local machine. Since `solars` is a Tauri app, in order to build it, please follow the steps to build `solars` on your platform [here][tauri-build]. You will need one of Tauri's CLI utilities installed, e.g., `tauri-cli`:
Clone this repository to your local machine. Since `solars` is a Tauri app, you may read the guides for [Developing Tauri apps][tauri-develop] and for [Building Tauri apps][tauri-build] on the official website.

You will need one of Tauri's CLI utilities installed, e.g., `tauri-cli`:

```
cargo install tauri-cli
cargo tauri build
```

Currently, `solars` is not distributed on any app platforms.
You can then build the application bundle for your local operating system:

[tauri-build]: https://tauri.app/v1/guides/building/

## Development
```
cargo tauri build
```

Clone this repository to your local machine. Since `solars` is a Tauri app, you can use the `tauri-cli` to run the development environment:
Or, launch the development server:

```
cargo install tauri-cli
cargo tauri dev
```

[tauri-build]: https://tauri.app/v1/guides/building/
[tauri-develop]: https://tauri.app/v1/guides/development/development-cycle

## License

This project is licensed under the MIT License.
Expand Down

0 comments on commit 5f9d41d

Please sign in to comment.