diff --git a/README.md b/README.md index ae5d1da..e1eb10e 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,16 @@ chmod +x ./vfio-setup * Enable and configure the correct kernel modules * Provides you with the correct kernel arguments to add to your bootloader entry +## Contributing +
+I know my bash skills are not great, so help is always welcome! And help is wanted here.
+If you know bash well, you will be able to help! Just make a pull request with your changes!
+Just remember to add comments to document the work and explain it for people who are less familiar with the bash syntax or anything else you use. 😄
+
+Also if you know english, you can just help proof reading. English is not my native language, plus I have dyslexia so I often make spelling mistakes.
+Proof reading is still contribution! + + ## TODO * ~~Everything~~ * ~~Show general warning to user and inform about making a backup and general expectations~~ @@ -39,4 +49,4 @@ chmod +x ./vfio-setup ### Why bash? I wanted the dependencies to be minimal without the need for compilation and not have a potential breaking change in the future (like with the transition from python2 to python3). -I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang. \ No newline at end of file +I know enough bash to make things work, but I am in no way a professional in writing bash scripts as I usually write python and golang.