diff --git a/README.md b/README.md index b94f1b7..b0a0431 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # easymacros -This program is inspired by xmacro, however it isn't xmacro. +This program is inspired by [**xmacro**](https://github.com/Ortega-Dan/xmacroIncludingDelayCapturing/), however it isn't `xmacro`. -Note: This program is for personal use. I will modify it as I deem necessary, but feel free to open issues for suggestions or bug reports. Contributions are welcome! +**Note**: This program is for personal use; I will modify it as I deem necessary, but feel free to open issues for suggestions or bug reports. Contributions are welcome! -## TODOs +# + +
+

:pen_ballpoint: TODOs :notepad_spiral:

- [ ] Playing macros (xmacro like) - [x] Delay support @@ -16,8 +19,11 @@ Note: This program is for personal use. I will modify it as I deem necessary, bu - [x] Delay - [x] Keyboard actions - [x] Mouse actions +# +
-## Ideas +
+

❔ Ideas 🧠

I may or may not do these, but they sound fun to implement to me! @@ -38,14 +44,22 @@ I may or may not do these, but they sound fun to implement to me! - [ ] calling/recording other macros - [ ] running commands - [ ] GUI Macro editor which is actually user friendly +# +
-## Platform support +
+

:desktop: Platform support :compression:

-- [x] Linux x11 (only tested on i3wm) -- [ ] Linux Wayland (makes heavy use of X apis, I will only do this if I myself switch to Wayland. I'm open to suggestions how to do it though!) -- [ ] MacOS (Might work because of XQuartz?) -- [ ] Windows (Yeah, I'm not doing that myself. Unless I have to use Windows for anything.) +- [x] Linux x11 (*only tested on `i3wm`*) +- [ ] Linux Wayland (*makes heavy use of X apis, I will only do this if I myself switch to Wayland. I'm open to suggestions how to do it though!*) +- [ ] MacOS (*Might work because of [XQuartz](https://www.xquartz.org/)?*) +- [ ] Windows (*Yeah, I'm not doing that myself. Unless I have to use Windows for anything.*) +# +
-## Installation +
+

:inbox_tray: Installation :newspaper:

-Currently only manually possible via `cargo build --release` and then moving the result into your $PATH. +Currently only manually possible via `cargo build --release` and then moving the result into your `$PATH`. +# +