Skip to content

Commit 70d704f

Browse files
committed
chore: created community standard files
Signed-off-by: Lennoard <lennoardrai@gmail.com>
1 parent 384f750 commit 70d704f

File tree

2 files changed

+77
-21
lines changed

2 files changed

+77
-21
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to SysctlGUI
2+
3+
First off, thank you for considering contributing to SysctlGUI! Your help is greatly appreciated. Whether it's reporting a bug, discussing improvements, or contributing code, every bit of effort makes this project better.
4+
5+
This document provides a set of guidelines for contributing to SysctlGUI. These are mostly guidelines, not strict rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
6+
7+
## How Can I Contribute?
8+
9+
There are many ways to contribute, and we welcome them all!
10+
11+
### Reporting Bugs
12+
13+
If you find a bug, please make sure it hasn't already been reported by searching the [GitHub Issues](https://github.com/Lennoard/SysctlGUI/issues).
14+
15+
When you are creating a bug report, please include as many details as possible:
16+
17+
* **A clear and descriptive title** for the issue
18+
* **Steps to reproduce the bug** in a clear, step-by-step list
19+
* **Describe the expected behavior** and what you observed instead
20+
* **Provide details about your environment:**
21+
* App version
22+
* Android version and ROM (e.g., Android 13, LineageOS 20)
23+
* Device model
24+
* Root solution (e.g., Magisk, KernelSU)
25+
* **Include logs** (like a Logcat) or screenshots if they are relevant
26+
27+
### Suggesting Enhancements
28+
29+
If you have an idea for a new feature or an improvement to an existing one, please open an issue to start a discussion.
30+
31+
* **Use a clear and descriptive title** for the issue
32+
* **Provide a detailed description** of the enhancement and why it would be useful
33+
* **Explain the problem it solves** or the workflow it improves
34+
* **Include mockups or screenshots** if they help illustrate your idea
35+
36+
37+
### Pull Requests
38+
39+
Code contributions are always welcome. If you can contribute with code, please do so.
40+
41+
42+
### Translations
43+
If you are fluent in another language, your help with translations would be invaluable.
44+
Please see the [translation guide](https://github.com/Lennoard/SysctlGUI/blob/develop/TRANSLATING.md) for detailed instructions on how to contribute translations.
45+
46+
47+
48+
# License
49+
By contributing to SysctlGUI, you agree that your contributions will be licensed under the [License](https://github.com/Lennoard/SysctlGUI/blob/develop/LICENSE) that covers the project.

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
11
<p align="center">
2-
<img width="108" height="108" src="https://i.imgur.com/TPKCbg6.png"/>
3-
</p>
4-
5-
<p align="center">
6-
<img height="360" src="https://lh3.googleusercontent.com/vmi_rXs0nfqfAh3woDLDRxDW0tx_UM1nx8zCda7nY4FoO6ebmvSQJaHT-GENzEOp34o"/>
7-
<img height="360" src="https://lh3.googleusercontent.com/DXaSIdkmBzUsQzPOkkIbY5YdKVsohcTb4IeSq9q70PPdG07yovHCD7X6XPebtesM0L0"/>
8-
<img height="360" src="https://lh3.googleusercontent.com/zrIdQ1jGiaDb_kfnxAPqd8bJwejjJzvq7whU-kGXvT0G86l3RHzuseAnZZpP7r3RaV0"/>
9-
<img height="360" src="https://lh3.googleusercontent.com/fpWBqB-qTRp1zfw6r7aBm6auQD7cdw-3vQbKsqwVVo5lcPHvQq96XKVdO1gRTydF8qU"/>
2+
<img width="160" height="160" src="https://i.imgur.com/TPKCbg6.png"/>
103
</p>
114

125
# SysctlGUI
136

7+
SysctlGUI is a Android application designed for power users, developers, and enthusiasts who want to
8+
fine-tune their device's performance by directly editing kernel parameters.
9+
It provides a user interface for the <code>sysctl</code> command-line utility,
10+
making advanced kernel tweaking accessible and manageable.
11+
12+
***Important: This app requires root access to work.***
13+
1414
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/d91bf38325aa4bb6b6cb67136f72f1f1)](https://www.codacy.com/gh/Lennoard/SysctlGUI/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Lennoard/SysctlGUI&amp;utm_campaign=Badge_Grade)
15-
![](https://img.shields.io/github/languages/top/Lennoard/SysctlGUI)
16-
![](https://img.shields.io/github/contributors/Lennoard/SysctlGUI)
17-
![](https://img.shields.io/github/downloads/Lennoard/SysctlGUI/total)
18-
![](https://img.shields.io/github/v/release/Lennoard/SysctlGUI)
19-
![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/Lennoard/SysctlGUI/latest/master)
15+
[![CodeQL Advanced](https://github.com/Lennoard/SysctlGUI/actions/workflows/codeql.yml/badge.svg)](https://github.com/Lennoard/SysctlGUI/actions/workflows/codeql.yml)
16+
[![Build Status](https://app.bitrise.io/app/03e8fa82-8168-4a7f-9005-b8e5d056417f/status.svg?token=3qlQfgAkEgxvr0JnvyzT_Q&branch=develop)](https://app.bitrise.io/app/03e8fa82-8168-4a7f-9005-b8e5d056417f)
2017

21-
A GUI application for Android <code>sysctl</code> to edit kernel variables
18+
![](https://img.shields.io/github/contributors/Lennoard/SysctlGUI)
19+
![](https://img.shields.io/github/downloads/Lennoard/SysctlGUI/total)
20+
![](https://img.shields.io/github/v/release/Lennoard/SysctlGUI)
21+
![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/Lennoard/SysctlGUI/latest/develop)
2222

2323
## Features
24-
- Browse filesystem for specific kernel parameters
25-
- Select parameters from a searchable list
26-
- Show documentation for known parameters
27-
- Load parameters from a configuration file
28-
- Reapply parameters at startup
29-
- Mark parameters as favorite for easy access
24+
- **Parameter Management:** Easily browse the filesystem or search a comprehensive list to find kernel parameters, with in-app documentation to help you understand their impact.
25+
- **Persistent Tweaks:** Automatically reapply your chosen settings on every boot.
26+
- **Configuration Profiles:** Save and load sets of parameters from configuration files, making it simple to switch between different performance profiles or share your setup.
27+
- **Favorites System:** Mark frequently used parameters for quick and easy access.
3028

3129
## Technologies
3230

@@ -56,11 +54,20 @@ This project utilizes a modern Android development stack, leveraging a comprehen
5654

5755
## Contributing
5856

59-
We welcome contributions to SysctlGUI!
57+
Contributions are always welcomed. Please see the [contributing guide](CONTRIBUTING.md) for more details on how to contribute with this project.
6058

6159
### Translations
6260
If you'd like to help translate the app into other languages, please see the [translation guide](TRANSLATING.md) for instructions on how to get started. Your contributions will help make SysctlGUI accessible to a wider audience.
6361

62+
## Screenshots
63+
64+
<p align="center">
65+
<img height="360" src="https://lh3.googleusercontent.com/vmi_rXs0nfqfAh3woDLDRxDW0tx_UM1nx8zCda7nY4FoO6ebmvSQJaHT-GENzEOp34o"/>
66+
<img height="360" src="https://lh3.googleusercontent.com/DXaSIdkmBzUsQzPOkkIbY5YdKVsohcTb4IeSq9q70PPdG07yovHCD7X6XPebtesM0L0"/>
67+
<img height="360" src="https://lh3.googleusercontent.com/zrIdQ1jGiaDb_kfnxAPqd8bJwejjJzvq7whU-kGXvT0G86l3RHzuseAnZZpP7r3RaV0"/>
68+
<img height="360" src="https://lh3.googleusercontent.com/fpWBqB-qTRp1zfw6r7aBm6auQD7cdw-3vQbKsqwVVo5lcPHvQq96XKVdO1gRTydF8qU"/>
69+
</p>
70+
6471
## Download
6572

6673
<a href='https://apt.izzysoft.de/fdroid/index/apk/com.androidvip.sysctlgui'><img alt='Get it on IzzyOnDroid' height="64" src='https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png'/></a>

0 commit comments

Comments
 (0)