Skip to content

Commit

Permalink
Update instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
elibroftw committed Sep 2, 2022
1 parent bb29f92 commit 3e40aa6
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,16 @@ Tauri and React boilerplate for a modern desktop application. Not a project nor
1. Install Tauri [prerequisites](https://tauri.studio/docs/getting-started/prerequisites)
2. Download or Clone this repository `git clone --depth=1 https://github.com/elibroftw/modern-desktop-app-template.git new-app`
3. Go into `new-app`
4. Install [NodeJS](https://nodejs.org/en/)
5. Install `yarn` with `npm i -g yarn`
6. Run `yarn` to install packages
7. While `yarn` is working,
4. Follow environment instructions in `SAMPLE_README.md`
5. While `yarn` is installing dependencies,
- Edit `src-tauri/tauri.conf.json's productName, identifier, title`
- Edit `src/App.jsx's HEADER_TITLE, FOOTER`
- Remove the `.git` folder
- Edit `SAMPLE_README.md` and replace `README.md`
- Delete or replace `LICENSE.md` since this template is public domain
8. Run `yarn dev` to start developing
9. Read [Tips and Trouble Shooting](#tips) section of the new `README.md`
10. If any problems arise, open an issue or contact me
6. Run `yarn dev` to start developing
7. Read [Tips and Trouble Shooting](#tips) section of the new `README.md`
8. If any problems arise, open an issue or contact me

## Old Instructions

Expand Down
9 changes: 8 additions & 1 deletion SAMPLE_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,17 @@ This project was bootstrapped with Create React App and converted to use Vite.
## Environment

- [Tauri Prerequisites](https://tauri.studio/docs/getting-started/prerequisites),
- Install [NodeJS](https://nodejs.org/en/) via [`nvm`](https://github.com/nvm-sh/nvm) or [`nvm-windows`](https://github.com/coreybutler/nvm-windows/releases) (`nvm install latest`)
- Install [NodeJS](https://nodejs.org/en/) via [nvm](#how-to-use-nvm)
- Install `yarn` using `npm i -g yarn`
- Run `yarn` to install frontend dependencies

### How to use nvm

1. Install [`nvm`](https://github.com/nvm-sh/nvm) or [`nvm-windows`](https://github.com/coreybutler/nvm-windows/releases)
2. Open up an elevated command prompt (Windows) or use `sudo` (POSIX) for the below commands.
3. `nvm install latest` which will output a version (X.Y.Z) that was installed
4. `nvm use X.Y.Z`

## Resources

- [Tauri (JS)](https://tauri.studio/docs/api/js/)
Expand Down

0 comments on commit 3e40aa6

Please sign in to comment.