Skip to content

Commit

Permalink
updated readme with more detaul about building and formatting edits
Browse files Browse the repository at this point in the history
  • Loading branch information
abjt14 committed Jan 16, 2023
1 parent 2def25c commit e10476f
Showing 1 changed file with 15 additions and 8 deletions.
23 changes: 15 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,33 @@

**Bongo Copy Cat** wants to be involved in everything you do but instead just imitates you hitting your keyboard all day. After all it's just a cat.

Supported platforms: **MacOS** and **Windows**.
Supported platforms: `MacOS` and `Windows`.

This is a practice project for me to learn [**Rust**](https://www.rust-lang.org/) and [**Tauri**](https://tauri.app/).

## About the meme
Bongo Cat is a meme created by [DitzyFlama](https://twitter.com/DitzyFlama) ([tweet](https://twitter.com/DitzyFlama/status/993487015499853824)) using [StrayRogue](https://twitter.com/StrayRogue)'s [drawing of a cat](https://twitter.com/StrayRogue/status/992994454058381312).

## Libraries that made this possible
* [**Rdev**](https://github.com/Narsil/rdev) for listening to global input events on Mac OS.
* [**InputBot**](https://github.com/obv-mikhail/InputBot) for listening to global input events on Windows.
* [Rdev](https://github.com/Narsil/rdev) for listening to global input events on Mac OS.
* [InputBot](https://github.com/obv-mikhail/InputBot) for listening to global input events on Windows.

## Installation
* Download exectuables for **MacOS** and **Windows** from the [releases](https://github.com/abjt14/bongo-copy-cat/releases) page.
* Download exectuables for `MacOS` and `Windows` from the [releases](https://github.com/abjt14/bongo-copy-cat/releases) page.
* Build it yourself.

## Building
You can always build the project youself. This will prevent the system from throwing warnings while installing an unsigned application.

* Download the source code from the [releases](https://github.com/abjt14/bongo-copy-cat/releases) page as a zip file or clone the project using `git clone`.
* Install the [**Rust**](https://www.rust-lang.org/tools/install) toolchain.
* You can build the **Tauri** project using **npm**, **yarn**, **pnpm**, or **cargo**.
* Install the [Rust](https://www.rust-lang.org/tools/install) toolchain.
* Install [Node Package Manager](https://nodejs.org/en/).

Don't just fork the project, give the cat a star ⭐️
Run the following in a terminal.
```bash
git clone https://github.com/abjt14/bongo-copy-cat.git
cd bongo-copy-cat
npm install
npm run tauri build
```

*Don't just clone the project, give the cat a star ⭐️*

0 comments on commit e10476f

Please sign in to comment.