Author Topic: Unofficial ULX documentation  (Read 127 times)

0 Members and 1 Guest are viewing this topic.

Offline Timmy

  • Respected Community Member
  • Full Member
  • *****
  • Posts: 182
  • Karma: 148
  • Code monkey
Unofficial ULX documentation
« on: October 07, 2018, 12:56:50 AM »
Hi everyone!

I am working on reference documentation for ULX. I would like to start this topic to share my progress and allow for feedback from the community.

The goal of this project is to provide users of ULX with reliable, organized and up-to-date reference material. The instructions do a bit of hand holding to improve the experience for new users. I aim to make the documentation accessible to as many users as possible.

It is a work in progress. Existing pages need to be fleshed out and others still need to be written.

Comments and suggestions are very welcome. :)

Documentation is available at https://timmy.github.io/ulx-docs/.

Offline JamminR

  • Ulysses Team Member
  • Hero Member
  • *****
  • Posts: 7906
  • Karma: 372
  • Sertafide Ulysses Jenius
    • Team Ulysses [ULib/ULX, other fine releases]
Re: Unofficial ULX documentation
« Reply #1 on: October 07, 2018, 11:51:18 AM »
BEAUTIFUL!! Keep up great work.

Re: Your developers section
Technically, ulx itself was never actually meant to be used as a development basis, as we in theory hoped ULib would be used as a building block for other projects. (again, technically, anything written for ULX uses ULib, but that's not always clear)

Though, even as I was learning G-Lua, I saw that it was often easier to learn ULib by building functions for ULX from other ULX commands as "templates" to then learn how some ULib features functioned in most respects.

All that being said, don't forget tot include links/mention of ULib in any of the Developers section
(s)
you feel it would fit.
The ULib documentation can be found here - http://ulyssesmod.net/docs/
The price one pays for pursuing any profession or calling is an intimate knowledge of its ugly side. - James Baldwin