Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ReimuNotMoe committed Jan 30, 2023
1 parent 43b1a11 commit 57ba7d0
Showing 1 changed file with 22 additions and 19 deletions.
41 changes: 22 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Generic Linux command-line automation tool (no X!)

**`ydotool` is not limited to Wayland.** You can use it on anything as long as it accepts keyboard/mouse/whatever input. For example, X11, text console, "RetroArch OS", fbdev apps (fbterm/mplayer/SDL1/LittleVGL/Qt Embedded), etc.

## Important Note
The man page is not always up to date. Please use `--help` to ensure correctness.

## ChangeLog
This project is now refactored. (v1.0.0)

Expand All @@ -23,25 +26,6 @@ Good News:
- `key` now (only) accepts keycodes, so it's not limited to a specific keyboard layout
- Now it's possible to implement support for different keyboard layouts in `type`

## Important Notes
### Current situation
This project is now being maintained **thanks to all the people that are supporting this project!**

All backers and sponsors are listed [here](https://github.com/TheNeuronProject/BACKERS/blob/main/README.md).

### How to support us
- Donate on our [Patreon](https://www.patreon.com/classicoldsong)
- Buy our products on our [Official Store](https://su.mk/store), if they are meaningful to you (please leave a message: `ydotool user`, so we can know that this purchase is for supporting ydotool)

### More talks
[Article: "Open Source" is Broken](https://christine.website/blog/open-source-broken-2021-12-11)

Independent software developers in China, like us, have 10 times more life pressure than Marak, the author of faker.js. Since ydotool has the opportunity to benefit large IT companies who won't pay a penny to us, we've changed the license to AGPLv3. These large IT companies are the main cause of life pressure here, such as the "996" working hours.

**Marak's fate will repeat on all open source developers eventually (of course we aren't talking about those who were born in billionare families) if we just _keep fighting with each other and do nothing to improve the situation._ If you make open source software as well, don't hesitate to ask for donations if you actually _need_ them.**

Also make sure you understand all the terms of AGPLv3 before using this software.

## Usage
Currently implemented command(s):
- `type` - Type a string
Expand Down Expand Up @@ -121,3 +105,22 @@ The identifier for your keyboard can be obtained from the output of `swaymsg -t

#### Use a hardware-configurable keyboard
[As mentioned here](https://github.com/ReimuNotMoe/ydotool/issues/43#issuecomment-605921288), consider using a hardware-based configuration that supports using a custom layout without configuring it in software.

## Older Notes
### Current situation
This project is now being maintained **thanks to all the people that are supporting this project!**

All backers and sponsors are listed [here](https://github.com/TheNeuronProject/BACKERS/blob/main/README.md).

### How to support us
- Donate on our [Patreon](https://www.patreon.com/classicoldsong)
- Buy our products on our [Official Store](https://su.mk/store), if they are meaningful to you (please leave a message: `ydotool user`, so we can know that this purchase is for supporting ydotool)

### More talks
[Article: "Open Source" is Broken](https://christine.website/blog/open-source-broken-2021-12-11)

Independent software developers in China, like us, have 10 times more life pressure than Marak, the author of faker.js. Since ydotool has the opportunity to benefit large IT companies who won't pay a penny to us, we've changed the license to AGPLv3. These large IT companies are the main cause of life pressure here, such as the "996" working hours.

**Marak's fate will repeat on all open source developers eventually (of course we aren't talking about those who were born in billionare families) if we just _keep fighting with each other and do nothing to improve the situation._ If you make open source software as well, don't hesitate to ask for donations if you actually _need_ them.**

Also make sure you understand all the terms of AGPLv3 before using this software.

0 comments on commit 57ba7d0

Please sign in to comment.