Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation by porting from softsynth.com #135

Open
mschwartz opened this issue Dec 12, 2022 · 4 comments
Open

Improve documentation by porting from softsynth.com #135

mschwartz opened this issue Dec 12, 2022 · 4 comments
Labels
docs documentation

Comments

@mschwartz
Copy link

mschwartz commented Dec 12, 2022

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
Copy link
Owner

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
Copy link
Author

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

@philburk
Copy link
Owner

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.

@philburk philburk changed the title Improve documentation Improve documentation by porting from softsynth.com Dec 12, 2022
@mschwartz
Copy link
Author

OK.

@mschwartz mschwartz reopened this Dec 12, 2022
@philburk philburk added the docs documentation label Jun 11, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation
Projects
None yet
Development

No branches or pull requests

2 participants