search

philburk / pforth

Portable Forth in C
BSD Zero Clause License
597 stars 98 forks source link

Improve documentation by porting from softsynth.com #135

Open mschwartz opened 1 year ago

mschwartz commented 1 year ago

I would like to do a PR to add a few .txt files including information gleaned from the WWW site.

For example, a compiling.txt (or .md, preferred), the text here:

http://www.softsynth.com/pforth/pf_ref.php#Compiling-pForth

Has zero effect on functionality as no .c files or .fth files would be added or modified.

philburk commented 1 year ago

Thanks for offering. I have been meaning to convert some of the docs on softsynth.com to MarkDown and include them in the GitHub repo. I would put them in a docs folder because there may eventually be a lot more docs.

mschwartz commented 1 year ago

My next PR. Let’s get my first on merged 😬

philburk commented 1 year ago

The PR for getopt() is very controversial and would need testing on multiple platforms to ensure there is zero regression. We seem to be out of sync on the design goals for pForth so it may be a very long time before the getopt changes get merged. On some other projects I got talked into adding dependencies and it introduced security holes and broke the project for a couple years. So I am very reluctant to add dependencies.

But adding docs is great so that would be an easy merge.

BTW, I am prepping for a 2.0.0 release for Debian. So I am just trying to fix bugs at this point and not add any risky changes.

mschwartz commented 1 year ago

OK.