Skip to content

Commit 878ecf7

Browse files
committed
docs: update readme
1 parent 25ab01b commit 878ecf7

File tree

2 files changed

+30
-7
lines changed

2 files changed

+30
-7
lines changed

README.md

Lines changed: 30 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,42 @@
11
# Helmer Micro
22

3+
![](banner.png)
4+
35
![Stage: Alpha](https://img.shields.io/static/v1?label=Stage&message=Alpha&color=2BB4AB)
46
[![License: AGPL3.0](https://img.shields.io/static/v1?label=Licence&message=AGPL%20v3&color=000)](https://www.gnu.org/licenses/agpl-3.0)
57
[![Twitter: @HelmerApp](https://img.shields.io/badge/Twitter-00acee?logo=twitter&logoColor=white)](https://twitter.com/helmerapp)
6-
![Github Stars](https://img.shields.io/github/stars/helmerapp/helmer-micro)
8+
![Github Stars](https://img.shields.io/github/stars/helmerapp/micro)
9+
10+
Helmer Micro is a commercial open source (COSS) cross-platform GIF recorder. It is written in Typescript and Rust, using the awesome desktop app framework [Tauri](https://github.com/tauri-apps/tauri), our high-performance capture engine [scap](https://github.com/helmerapp/scap) and the fabulous encoder, [Gifski](https://github.com/ImageOptim/gifski).
711

812
> ⚠️ This project is in Alpha and things break often. Please use at your own risk.
913
10-
## Installation
14+
## Motivation
15+
16+
GIFs are clearly the internet's favourite file format, but notoriously hard to create. We wanted to create a small tool that allows easy, effortless creation of GIFs and share it with as many people as possible!
17+
18+
In addition to our small mission, this project also stands for 2 things:
19+
20+
1. an example of how to use our library [scap](https://github.com/helmerapp/scap) and
21+
2. show that open-source software can (and should!) be beautifully designed!
22+
23+
## COSS?
1124

12-
Helmer Micro is being developed as COSS: Commercial Open-source Software. It's source code is kept up-to-date and made available to everyone through this Github Repo.
25+
Yup, Commercial Open-source Software! Many of the libraries and tools we make are kept up-to-date and made available to everyone though Github and other platforms. We believe in operating with full transparency, building alongside our community and support our peer OSS projects along the way. This way, everyone benefits instead of running circles within walled gardens.
1326

14-
If you'd like to support our work, we request you to buy a license via [our website](https://www.helmer.app/micro) and share your GIFs online with a `#MadeWithMicro` hashtag that will allow us to find it online too!
27+
If you benefit from our work, we request that you buy a license via [our website](https://www.helmer.app/micro). This commercialization allows us to become sustainable and also creates a symbiosis between OSS and its proprietary license counterpart — a credible new way of funding our work and experiments!
28+
29+
Of course, you are more than welcome to build your own binaries using our source-code! Please also reach out via our Discord if you need help setting this up.
30+
31+
Don't forget to share your GIFs online with a `#MadeWithMicro` hashtag, we would love to see and share what you make!
1532

1633
## Development
1734

1835
### Pre-requisites
1936

20-
1. Follow [this guide](https://tauri.app/v1/guides/getting-started/prerequisites) to set up Rust and other system dependencies.
21-
2. Install [NodeJS](https://nodejs.org/en) v18.17.0 LTS (or newer)
22-
3. Install Yarn Package Manger by running `npm install --global yarn`
37+
1. Set up all the [Tauri Pre-requisites](https://beta.tauri.app/guides/prerequisites/) to set up Rust and other system dependencies.
38+
2. Install [NodeJS](https://nodejs.org/en) 20.0 (or newer)
39+
3. Install Yarn by running `npm install --global yarn`
2340

2441
### Guide
2542

@@ -28,3 +45,9 @@ This is a [Tauri](https://tauri.app) app. It uses [Astro](https://astro.build) f
2845
1. To spin up the dev environment, run `yarn tauri dev`
2946
2. To build the app for your current OS/architecture, run `yarn tauri build`
3047
3. Follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#specification) spec to name branches and commits.
48+
49+
---
50+
51+
## Credits
52+
53+
(coming soon)

banner.png

327 KB
Loading

0 commit comments

Comments
 (0)