XenonRecomp icon indicating copy to clipboard operation
XenonRecomp copied to clipboard
verified publisher icon hedge-dev

Add Usage.md

Open jaroshevskii opened this issue 9 months ago • 3 comments

How is it difficult for a beginner to understand how to work with it

jaroshevskii avatar Mar 04 '25 20:03 jaroshevskii

There's a usage section in README.md no?

Ziimmie avatar Mar 05 '25 02:03 Ziimmie

There's a usage section in README.md no?

There is, but it's not very clear on how to use it. For example the XenonAnalyse, needs you to name the toml file in the output directory, but isn't stated under the usage section and the part I'm trying to figure out with XenonRecomp is the recompiler configurations.

One of the members for Hedge-Dev have stated they are planning on making a proper usage/user guide after they have finished with bug reports from Unleashed Recompiled. So hopefully that will be soon. Link For Reference

killer93551277 avatar Mar 05 '25 04:03 killer93551277

I've been working with XenonRecomp and wanted to share some feedback regarding the README. While I appreciate the effort put into it, I believe it could be enhanced to better assist users. Here are a few areas that could use improvement:

  1. File Structure: Including a section that details the file structure would be extremely helpful. This will give users a clear understanding of where to find important files and how the project is organized.

  2. Config.toml Explanation: Providing an explanation or sample config.toml file can guide users on how to configure the project according to their needs.

  3. Usage Instructions: More comprehensive instructions on how to use XenonRecomp and XenonAnalysis would be beneficial. This could include common use cases, command-line options, and examples.

  4. Compilation by Hand: A step-by-step guide on how to compile the project manually would be valuable, especially for users who prefer or need to compile the code themselves.

  5. Handling Segfaults: Including a troubleshooting section with common errors and solutions, such as what to do if a segmentation fault occurs, would enhance the user experience.

To address these points, I suggest creating a detailed wiki with step-by-step instructions and guides. This would provide a centralized and accessible resource for users, ensuring they have all the information needed to effectively utilize XenonRecomp.

Thank you for considering this feedback. I'm looking forward to the improvements and continued success of XenonRecomp.

ryzendew avatar Mar 06 '25 22:03 ryzendew