diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 2fcf1c6..1994f17 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -10,12 +10,8 @@ assignees: '' **Describe the bug** A clear and concise description of what the bug is. -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +**To reproduce** +Steps to reproduce the behavior. [click this, type that, see error] **Expected behavior** A clear and concise description of what you expected to happen. @@ -23,10 +19,10 @@ A clear and concise description of what you expected to happen. **Screenshots** If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +**System information** + - OS or Linux distribution: [Ubuntu, Arch, ...] + - How did you install Konsave? [from the distro's package manager, using pip, directly from git, ...] + - What version of Konsave are you using? Did you try updating? **Additional context** Add any other context about the problem here. diff --git a/README.md b/README.md index 9f14fe0..8434b41 100644 --- a/README.md +++ b/README.md @@ -20,16 +20,20 @@ There are no dependencies! Just make sure your python version is above `3.8`. ## Usage ### Get Help -`konsave -h` +`konsave -h` or `konsave --help` ### Save current configuration as a profile -`konsave -s ` +`konsave -s ` or `konsave --save ` ### List all profiles -`konsave -l` +`konsave -l` or `konsave --list` ### Remove a profile -`konsave -r ` +`konsave -r ` or `konsave --remove ` ### Apply a profile -`konsave -a ` +`konsave -a ` or `konsave --apply ` You may need to log out and log in to see all the changes. +### Export a profile as a ".knsv" file to share it with your friends! +`konsave -e ` or `konsave --export-profile ` +### Import a ".knsv file +`konsave -i ` or `konsave --import-profile ` ## Contribution You can contribute by reporting issues or fixing bugs!