Documents?

[Syphurith]

As we know rxTools is recently donated to pasta, and its original owner @roxas75 left us.
There are many guys having issues with the new 2.6 release - that its setup differs from old one.
And, some of us doesn't understand it well, at least including myself.
Also, even how-to-build troubles who want to help. No architecture, code-style or other planned.
We can't get the running compatibility easily by viewing a graph or table.

The doc directory would keeps those documents, I personally perfer Markdown so we can directly view it on Github. There is CuteMarked as a good Editor. Those docs don't infer with the code so there would be no difference in binary and can be merged safely - if the content is correct.
doc folder could be included in the release zip file to offer new users easy-to-get tutorials. Those could be discussed or even splitted into another repo if you think that's polution to the main repo.

I don't know if you need documents anyway. So i opened up a issue for this.
You don't need to be afraid that doing a lot of documents job. You can find guys who want to R/W.
Once they understand how this works, they would find new features available.
If you don't think this is needed, you can still leave this open. There might be guys.

[AlbertoSONIC]

My priority is getting the gui work done, but onve i finish, i'll be happy to help to document rxtools source

[Syphurith]

@AlbertoSONIC Thanks. I think this could be left open if someone would like to do so.
Still waiting for one from China to contact me here. I hope he could do some tutorial/FAQs

[AlbertoSONIC]

Ok! 👍

[dukesrg]

How about starting from github WiKi?

[Syphurith]

@dukesrg Eh.. No actually. Wiki is only "edit"-able for owner/collaborator and that caused much problem when i was reading rpcs3 code. And Wiki can not be easily packed into a zip with rxTools.

[173210]

You can do it easily. GitHub wiki is managed with Git, so you can clone it.
https://help.github.com/articles/adding-and-editing-wiki-pages-locally/

If you want to permit everyone to edit, see this.
https://help.github.com/articles/changing-access-permissions-for-wikis/

If you want to prevent others from editing documents, I suggest to use gh-pages branch.

[Syphurith]

@173210 Thanks for telling me about wiki. Still not considering wiki, cause it can not be incldued directly, and even a seperate repo just for docs better than it. So sorry now.

[nastys]

I could write a PDF file with all the documentation (compiling, rxMode, how to create the emuNAND, how to inject files, etc...) :)

[DarkMatterCore]

If you worry about different languages/regions, I can help with a Spanish document, too.

[Syphurith]

@nastys @DarkMatterCore Thanks. Eh isn't PDF difficult to edit? I think a plane text format (Makedown, rst, or other) could be much better. Multi-Region.. Eh there might be a plan.

[nastys]

@Syphurith I'm writing it with LibreOffice Writer (which can export to PDF).

It should look like this document eventually: https://wiki.documentfoundation.org/images/7/7a/0212WG34-TOCsIndexesBiblios.pdf

edit: I'll also create a quick start guide with LibreOffice Draw.

[dukesrg]

I personally don't see need of any offline documents while it is anyway will have a number of internet links in it. If you hope that this will reduce the number of silly questions more than just a wiki, then it's not :(

[nastys]

After I'm done with this document, I'll start writing the wiki as well.

[Syphurith]

@dukesrg This should not only aim at those users. In fact i would like to see the purpose/architecture that (the) important (one) be documented, so new devs would find an easy way to understand this.
BTW, i do like those documents titled as "Never read me please" or "18X video link" (orz)
@nastys thanks for your effort. Many thanks.

[nastys]

Documentation has been added! 😄
I would like to cover the code as well, but I don't know much about that...

[Syphurith]

@nastys Not a big problem, we are not so familar with the project now. Here you a demo fragment.

• What does rxMode do?
  • Its main purpose is patch FIRM to achieve (firmlaunch?) and region-free. Most haxs are in .s. Region-free be in MyThread.c.
• How is this done?
  • (blabla)
• Note
  • Those region-free stuff contains no main and its symbol be global. It is said to achieve using a timing, while there is exact 16-byte code in decrypted FIRM.

[BitVortex]

For easier translation, how about converting the document to LaTeX? We could have one main document for formatting and stuff and sub-documents for text and images that would allow for documentation in multiple languages. In my experience, LaTeX is very well suited for this task.

I'd have to problem converting the current files for LaTeX editing. Any demand?