Skip to content

Commit

Permalink
feat: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vimfn authored Jun 24, 2023
1 parent 7a4006f commit d34ae44
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@

[output.webm](https://github.com/its-ag/PhysicsWallah-Desktop/assets/102473837/2467c856-4142-4463-8420-2f5fc7fb0d9c)

<p align="center">
<img alt="Download (Windows 7/8/10/11)" src="https://img.shields.io/github/downloads/its-ag/PhysicsWallah-Desktop/total?color=%23b7410e">
</p>

### Overview

This is an efficent, and lightweight desktop app implementaion of the [PhysicsWallah](https://pw.live) website.

They have a really nice website, but running within a browser thab is not always efficient and can be sometimes distracting, so that is why I made this desktop with Tauri, a modern rust framekwork.

I had not written some Rust code in a while so I made this simple project to brush up my Rust skills a bit (still very beginner, and contributions are very welcome).

### Ussage 📦

**Download the installer:**
- [Windows](https://github.com/its-ag/PhysicsWallah-Desktop/releases/latest/download/Physics.Wallah_1.0.0_x64_en-US.msi)
- Linux and Mac (coming soon)

Check [releases](https://github.com/its-ag/PhysicsWallah-Desktop/releases) tab for change logs.

### Roadmap 🗺

- [x] A Light weight desktop app
- [x] Multithreading support.
- [ ] Dark mode Support (WIP)
- [ ] Linux and Mac OS support
- [ ] *Suggest more...*


### Contribute 🧭
Contributors are welcomed and greatly appreciated, you can contribute bug fixes and new features.
> You are not allowed to add anything that will endorse piracy or will grant users any advantages over others.
First Setup your development environment for [building Tauri Apps](https://tauri.app/v1/guides/getting-started/prerequisites).

- Fork the Project
- Clone the repo and cd into the project directory.
- Install packages (`pnpm install`)
- Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
- Run the project in dev mode (`pnpm dev`) and add changes
- Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
- Push to the Branch (`git push origin feature/AmazingFeature`)
- Open a Pull Request

### Help and Support 🙌

![Discord Banner 3](https://discordapp.com/api/guilds/1085941898054738072/widget.png?style=banner3)

### License 📃

This Project is circulated under [CC0 1.0 Universal](./LICENSE) License.

### Copyright ©

- [Legal Notice](./LEGAL_NOTICE.md)

0 comments on commit d34ae44

Please sign in to comment.