Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

1 Update sommaire on readme #1088

Closed
wants to merge 13 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 31 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
# <img src="./src/images/antimicrox.png" alt="Icon" width="60"/> AntiMicroX

1. [Description](#description)
2. [License](#license)
3. [Installation](#installation)
4. [Wiki](#wiki)
5. [Command Line](#command-line)
6. [Testing Under Linux](#testing-under-linux)
7. [AntiMicroX Profiles](#antimicrox-profiles)
8. [Support](#support)

- [Description](#description)
- [License](#license)
- [Installation](#installation)
- [windows](#windows)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You just added a glossary entry to paragraph, which takes literally 2 lines.

This does not make sense. That's why installation section does not have links to its subsections

- [Flatpak](#flatpak)
- [AppImage](#appimage)
- [Debian_Ubuntu](#debianubuntu-based-distributions)
- [Fedora](#fedora)
- [openSUSE](#opensuse)
- [Arch_Linux](#arch-linux-or-arch-linux-based-distributions)
- [From_Sources](#building-yourself)
- [Wiki](#wiki)
- [Command Line](#command-line)
- [Testing Under Linux](#testing-under-linux)
- [AntiMicroX Profiles](#antimicrox-profiles)
- [Support](#support)
- [contributing](#contributing)
- [translation](#translation)
------------
## Description

AntiMicroX is a graphical program used to map gamepad keys to keyboard, mouse, scripts and macros. You can use this program to control any desktop application with a gamepad on Linux🐧 and Windows 🪟.
Expand Down Expand Up @@ -58,13 +67,17 @@ Disclaimer: Theme may depend on your system configuration.
</tr>
</table>

------------

## License

This program is licensed under the GPL v.3. Please read the LICENSE text document
included with the source code if you would like to read the terms of the license.
The license can also be found online at
http://www.gnu.org/licenses/gpl.txt

------------

## Installation

### Windows
Expand Down Expand Up @@ -163,10 +176,14 @@ Run `antimicrox --help` or read `man antimicrox` for command-line parameters.
fo file <code>~/.bashrc</code>
</details>

------------

## Wiki

[Look here](https://github.com/AntiMicroX/antimicrox/wiki)

------------

## Testing Under Linux

If you are having problems with antimicrox detecting a controller or
Expand All @@ -178,13 +195,17 @@ testing with older programs that use joydev won't be as helpful since some
devices behave a bit differently between the two systems. Another method also exists,
which can be found [here](https://github.com/juliagoda/SDL_JoystickButtonNames).

------------

## AntiMicroX Profiles

If you would like to send the profile you are using for your application or find something
for yourself, [here](https://github.com/AntiMicroX/antimicrox-profiles) is the forked repository. If you want to report a bug, ask
a question or share a suggestion, you can do that on the antimicrox page or on the
[antimicrox-profiles](https://github.com/AntiMicroX/antimicrox-profiles) page.

------------

## Support

There are several ways to get help with AntiMicroX. The easiest way is to upvote (with 👍) issues you thing are the most important ones. It is also possible to fund some issues using [Polar](https://polar.sh) platform to attract contributors.
Expand Down