Skip to content

Commit

Permalink
Edited README.md 🖋️
Browse files Browse the repository at this point in the history
and some of README's assets
  • Loading branch information
oyedejioyewole committed Mar 29, 2023
1 parent eb94c56 commit d34f2dc
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 9 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

![Preview](./docs/preview.png)

![GitHub repo size](https://img.shields.io/github/repo-size/OyewoleOyedeji/javabattery?color=%23191910&label=Repository%20size&logo=Github&style=for-the-badge)
![GitHub repo size](https://img.shields.io/github/repo-size/OyewoleOyedeji/javabattery?color=%23191910&label=Repository%20size&logo=Github&style=for-the-badge)  ![GitHub release (latest by date)](https://img.shields.io/github/v/release/OyewoleOyedeji/javabattery?color=191919&label=Latest%20version&style=for-the-badge)

## Supported Platforms <img src="docs/windows.svg" width="40" align="right" />&nbsp;&nbsp;&nbsp;&nbsp;<img src="docs/linux.svg" width="40" align="right" />

Expand All @@ -23,12 +23,24 @@

The commands I'll be using are for `pnpm`, but you can use `yarn` or `npm` if you want.

- Step 1

```bash
# Install dependencies and build icons used in the project

$ pnpm install
```

- Step 2

```bash
# Create the icons used in the project
$ pnpm build:icons
```

- Step 3

Copy `build/icons/icon.ico` to `public/` and then rename `icon.ico -> favicon.ico`

## Running

### Development
Expand All @@ -37,7 +49,6 @@ After running the command below a window open and the project will be running on

```bash
# Runs the development server and opens electron

$ pnpm dev
```

Expand All @@ -46,9 +57,7 @@ $ pnpm dev
To build and package the application, run the following command:

```bash
# Builds the frontend and packages the app based on the
# current operating system

# Builds the frontend and packages the application
$ pnpm release
```

Expand Down
6 changes: 5 additions & 1 deletion docs/linux.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion docs/windows.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
"productName": "Javabattery",
"scripts": {
"build": "nuxt generate",
"build:icons": "magick convert -background transparent build/icon.svg -define icon:auto-resize build/icons/icon.ico && magick convert -background transparent build/icon.svg build/icons/icon.png",
"dev": "nuxt dev",
"debug": "vue-devtools",
"icons": "magick convert -background transparent build/icon.svg -define icon:auto-resize build/icons/icon.ico && magick convert -background transparent build/icon.svg build/icons/icon.png && cp build/icons/icon.ico public/favicon.ico",
"package": "electron-builder --dir",
"postinstall": "nuxt prepare && node node_modules/vite-plugin-electron-renderer/install.js",
"release": "nuxt generate && electron-builder"
Expand Down

0 comments on commit d34f2dc

Please sign in to comment.