beenull/linux-surface
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Add contrib directory

Browse source
This commit is contained in:
Maximilian Luz 2021-04-20 15:48:26 +02:00
parent ca4e665738
commit a2360515c5
No known key found for this signature in database
GPG key ID: 70EC0937F6C26F02
2 changed files with 32 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -30,13 +30,14 @@ See the [feature matrix](https://github.com/linux-surface/linux-surface/wiki/Sup
* For the most part, things are tested on a Surface Book 2.
While most things are reportedly fully working on other devices, your mileage may vary.
Please look at the issues list for possible exceptions.
Please look at the issues list for possible exceptions.
## Installation and Setup
We provide package repositories for the patched kernel and other utilities.
Please refer to the [detailed installation and setup guide][wiki-setup]. There,
you may also find device-specific caveats.
Please refer to the [detailed installation and setup guide][wiki-setup].
There, you may also find device-specific caveats.
After installation, you may want to have a look at the [wiki][wiki] and the `contrib/` directory for useful tweaks.
If you want to compile the kernel yourself (e.g. if your distribution is not supported), please have a look at the [wiki][wiki-compiling].
@ -59,6 +60,7 @@ These patches fall thus, if not explicitly stated otherwise, under the license o
Please refer to the specific patch and source in question for further information.
License texts can be obtained at https://github.com/torvalds/linux/tree/master/LICENSES.
[wiki-setup]: https://github.com/linux-surface/linux-surface/wiki
[wiki-setup]: https://github.com/linux-surface/linux-surface/wiki/Installation-and-Setup
[wiki-compiling]: https://github.com/linux-surface/linux-surface/wiki/Compiling-the-Kernel-from-Source

27
contrib/README.md Normal file
View file

@ -0,0 +1,27 @@
# Scripts, Tweaks, and Configuration Bits
This directory contains scripts, tweaks, and configuration examples aiming to improve your Linux experience on Surface devices.
Any config files in these directories should be treated as examples and basis for adapting your own config files.
Feel free to send us a pull-request if you feel that something is missing or can be improved.
## Layout and Structure
Entries should be put into individual directories with a README.md.
This readme should state the purpose of that tweak/script and, if there are any config files, where those files should be placed (or any other installation instructions and hints).
Ideally, it should, for config files, also give an explanation of what is/has to be changed and why.
In general, config files should be kept minimal, if possible contain comments, and users should be encouraged to modify their config file instead of simply copying the one provided.
The overall structure should look something like this:
```
contrib
│
├─ some-script
│ ├─ the-script.sh
│ └─ README.md
│
└─ some-tweak
├─ a.conf
├─ b.conf
└─ README.md
```