search

andreas-jonsson / virtualxt

Portable, lightweight Turbo PC/XT emulator written in C.
https://virtualxt.org
zlib License
78 stars 17 forks source link

Documentation #61

Open fmahnke opened 1 year ago

fmahnke commented 1 year ago

Do we have a community documentation effort somewhere besides the git repo? If not, could we start a github wiki for VXT? There's a growing list of nice features, but I think some people may move on because they overlook them or can't figure out how to use them.

Documentation of the VXT_ environment variables would be interesting for anyone who wants to build and run from source. Documenting usage and creation of Lua modules and the GDB stub would be helpful for developers and power users.

When I want to do something new with VXT, I usually have to read its source code or ask in the issue tracker. These things don't bother me, so I wait until I have the time and then I do them and try to keep notes on how things work. Most end users won't even know how to read the code, though, so it would be good to have a place to put our knowledge that helps newcomers get started.

andreas-jonsson commented 1 year ago

There was a manual once. But it was very thin and it did nor survive the rewrite.

I can add a wiki but it likely depends on contributions. :)