Skip to content

Commit

Permalink
Create BUILD.md
Browse files Browse the repository at this point in the history
  • Loading branch information
1whatleytay committed Mar 18, 2024
1 parent 8fede60 commit af14e0c
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 23 deletions.
25 changes: 25 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Building Saturn

Saturn uses Tauri and has a Typescript frontend and Rust backend.
For contribution purposes, you can contribute to the app by building Saturn locally.

First, please install the following tools:

- [Node](https://nodejs.org/en)
- [Rust](https://www.rust-lang.org)
- [Yarn (Classic)](https://yarnpkg.com)

Before development, install dependencies using
```
yarn install
```

To run for development, use
```shell
yarn tauri dev
```

To build a binary for your platform, use
```shell
yarn tauri build
```
26 changes: 3 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,26 +38,6 @@ Then follow this instructions in the installer. Saturn should be installed on yo

# Building

Saturn is built with Tauri and has a Typescript and Rust component.
For contribution purposes, you can contribute to the app by building Saturn locally.

First, please install the following tools:

- [Node](https://nodejs.org/en)
- [Rust](https://www.rust-lang.org)
- [Yarn (Classic)](https://yarnpkg.com)

Before development, install dependencies using
```
yarn install
```

To run for development, use
```shell
yarn tauri dev
```

To build a binary for your platform, use
```shell
yarn tauri build
```
For instructions on building Saturn from source, see [BUILD.md](BUILD.md).
Typically, you'd want to build Saturn from source if you're trying to develop, add features, or support a new platform.
Otherwise, you should see the Installation section to install a prebuilt binary.

0 comments on commit af14e0c

Please sign in to comment.