exozyme/exozyme
7
12
Fork 0
Code Issues 4 Pull requests Projects Releases 39 Wiki Activity

Clean up README

Browse source
This commit is contained in:
Anthony Wang 2021-10-31 12:41:01 -05:00
parent 61e11433f6
commit 9e1812ad74
1 changed files with 5 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,17 +1,11 @@
# The exozyme project
Welcome to the libre, high-performance, privacy-respecting cloud!
Welcome to the main development repository for exozyme, the libre, high-performance, privacy-respecting cloud!
## Help out!
## Reporting issues
### Reporting bugs
Did you find an exozyme bug or security flaw? Go to our [issues tracker](https://git.exozy.me/exozyme/exozyme/issues), and first search for your issue to see if it's already been reported and if there are workarounds. If it's already been reported, you can comment with any additional information you have about the issue. If not, create a [new issue](https://git.exozy.me/exozyme/exozyme/issues/new), and write a **descriptive** title for the issue and provide **as much information as possible**, such as the expected behavior and what actually happens or any relevant logs.
Did you find an exozyme bug or security flaw? If so, click on the [Issues tab](https://git.exozy.me/exozyme/Issues/issues) to open up our bug tracker. Before you report the bug, search for some keywords related to your bug to see if it's already been reported and if there are workarounds for it. If there's already an issue for your bug, add a comment describing how you are affected by the bug. If not, then create a [new issue](https://git.exozy.me/exozyme/exozyme/issues/new). Make sure you write a **descriptive** title for the bug and give **as much information as possible** in the description of the bug, including what you want to do, the expected behavior and what actually happens, and any relevant log files.
## Fixing issues
### General troubleshooting tips
If you want to run an app and it's not working, try running it in a terminal. You can usually use a command similar to the app's name to run it in a terminal. For instance, for SuperTuxKart, run `supertuxkart` in a terminal window. If you aren't sure what the right command is, type a few characters of the name and use the tab key to see all the autocompleted results. Running the app from the command line will print out a lot of logging and debugging information, which you should copy and paste into your bug report. For graphic apps, you may also want to try running it with [vglrun](https://git.exozy.me/exozyme/exozyme/issues/3) in a terminal window.
### Bug wrangling
If you want to help us fix some bugs, check out the [issues tagged with "help wanted"](https://git.exozy.me/exozyme/exozyme/issues?q=&type=all&sort=&state=open&labels=4&milestone=0&assignee=0). See if you can find something to contribute too, or leave a few comments, or even just vote on issues with 👍 and 👎.
Please help us fix exozyme issues! The issues labeled [help wanted](https://git.exozy.me/exozyme/exozyme/issues?q=&type=all&state=open&labels=4&milestone=0&assignee=0) are usually good to contribute to. You can also leave a few comments or even just vote on issues with 👍 and 👎.