[Xastir] Poll: how do you like your documentation served up?

[Dj Merrill]

I'm still running Xastir on a Raspberry Pi.

My personal preference is having a readme file included with the source 
code, but I've been doing this for 35+ years so I might have a slight 
bias... :-)

I would say pick whatever method of documentation is easiest for you to 
maintain, and get rid of the other methods to avoid the duplication of 
effort.

-Dj


On 12/11/25 13:46, Tom Russo wrote:
> Xastir's documentation is a bit, um, fragmented? We have READMEs of 
> various
> vintages, we've got a wiki that is sometimes (but not often) kept 
> up-to-date.
>
> I am starting to look into revamping more of our documentation, starting
> with README.MAPS (which is very, very outdated and not at all a good
> resource for first time users). I have to decide whether to rewrite the
> whole file or pitch it and just do the documentation on the wiki. We
> already have a "HowTo:MAPS" wiki page which is a subset of README.MAPS and
> almost as out of date. I don't want to have to maintain TWO documentation
> sets, as keeping them synced is a maintenance headache.
>
> So, of you remaining Xastir users, what would you prefer to look at: 
> README
> files or a wiki, or something else?
>
> And if you can imagine yourself being a first-time Xastir user, what would
> you prefer to be told to do when you have to learn how to do something for
> the first time:
> "go look at our wiki on page xxxxx" or "go read the file README.XXX" or
> something else?
>
>
> And while I'm at it: "do you actually use Xastir anymore?"
>

-- 
Dj Merrill - N1JOV
Currently Flying: Glastar
Previously: Cessna 150 - Glasair 1 FT - Grumman AA1B