350 Commits
Author SHA1 Message Date
Landon Curt Noll ed05401669 Update faq.md FAQ2.4
Fix typo in FAQ2.4.
2023-11-20 03:23:53 -07:00
Landon Curt Noll d9a38d703a Update faq.md FAQ 6.2
Encourage forking and keeping such forks up to date.
2023-11-20 03:19:21 -07:00
Cody Boone Ferguson bc35c37748 Improve how gcc/clang is detected in Makefiles
Rather than check if $(CC) IS gcc or IS clang check for $(CC) containing
gcc or clang. This is because in some systems or conditions the compiler
might not be called JUST gcc or JUST clang. For instance gcc in MacPorts
is called gcc-mp-13 (for example) but without this change one would have
to symlink gcc to gcc-mp-13 or copy it to gcc.

The FAQ has been updated to address this.
2023-11-18 06:10:02 -08:00
Cody Boone Ferguson ee6f09403a Updates and improvements to 2000/thadgavin
The alt code now allows one to quit early (in curses mode) and this
calls endwin() to restore terminal sanity. Due to the way the code is
designed the function which does that has to be defined three times but
only one has any code in it, that of the curses one. This means that
nodelay() is also called when initialising curses. At least at this time
the original entry does not have this feature and so one will have to
type 'reset' after they end the program to restore terminal sanity.

The alt code has been improved in another way too: now one does not have
to specify both macros at the command line when wishing to configure
only one of the programs. This is accomplished by #ifndef..#endif blocks
at the beginning of the file. That has not been done in other entries
but probably should be to help out.

The README.md file has been typo/format checked/fixed.

The FAQ has been updated as well: a question about how to use entries
that require curses has been added. This required some minor reordering
of the numbers but I believe that I got everything okay.
2023-11-14 06:15:09 -08:00
Cody Boone Ferguson 7352698d27 Improve the way the FAQ table of contents looks 2023-11-13 04:23:03 -08:00
Cody Boone Ferguson a3b7e51289 Try fixing links in FAQ format test 2023-11-13 04:10:24 -08:00
Cody Boone Ferguson f91e883def Test change in format of FAQ table of contents
Only the first two sections have had a change so that we can see it side
by side to see what looks better.
2023-11-13 04:08:25 -08:00
Cody Boone Ferguson be04376fa6 Minor fixes and clarifications in FAQ
This includes typos, inconsistencies as well as updates to referring to
an entry to show how clang can complicate matters (sometimes greatly)
but making your entries work with clang will make your entry better.
2023-11-13 04:00:09 -08:00
Landon Curt Noll d0facb9eab update FAQ and add FAQ section numbers
A number of the FAQ questions strings were rewritten to be order,
a big more consistent in tone, and without any markdown symbols.

Each FAQ section has an HTML name tag before the section.
This has been done as an experiment in linking.

The FAQ table of contents has links into the FAQ sections,
however those links are using the current HTML name tags
and may not work in the `faq.md` markdown document.
We are not sure this will work, but we followed this suggestion:
https://stackoverflow.com/questions/6695439/how-to-link-to-a-named-anchor-in-multimarkdown
2023-11-13 00:02:31 -08:00
Cody Boone Ferguson e791883029 Try fixing anchor in FAQ
The problem might be that it appears that I accidentally had a '#' in
the name/id. Now trying it without the '#' as that is incorrect.
2023-11-12 04:28:46 -08:00
Cody Boone Ferguson 4ab8eed714 Test <a id="..."> for FAQ entry 2023-11-12 04:27:08 -08:00
Cody Boone Ferguson 4ba4dde279 Update FAQ about 32-bit versus 64-bit entries 2023-11-10 08:54:03 -08:00
Cody Boone Ferguson 934ac91291 Remove embedded CSS in faq.md
Unfortunately it is rendered literally in GitHub so this will not work.
Also '\' was removed from two lines in the file which were also rendered
literally (though that might be because of the <head> and <style>
related problem. Instead <br> has been used.
2023-11-10 04:13:12 -08:00
Cody Boone Ferguson 6438fc34d3 Update FAQ wrt X11 entries in macOS
There are three new images in png/ which are part of this entry. It
might be reasonable to remove ne but to keep it consistent with the rest
of the answer it is kept there for now.

This commit is partly a test to see how it comes out with GitHub and
also in general so that it might have to be revised.

The faq.md has had some html added as well, not only embedded CSS style
for 'img' to hopefully make it responsive but also the question has a
named anchor to link to more easily later on (this is likely to happen
to the rest of the questions/answers at another time).
2023-11-10 04:10:21 -08:00
Landon Curt Noll d7fa1400c3 improve FAQ about rule 2
While trying to find FAQ 4 and 5 we noticed some FAQ text
that needed improving.
2023-11-09 13:07:21 -08:00
Cody Boone Ferguson 723df90fa3 Fixes in FAQ and todo files
The FAQ has been updated to add something that was missing to the entry
about the general Makefile rules (make clobber, make all, make alt etc.)
that was in the todo. This has been removed from the todo.md as well.

Fix link in FAQ: not how-to-bugfix.md but how-to-help.md as I changed
this a while back as it isn't a matter of fixing a bug (which could be
any number of problems) but rather how to help with the website etc.

Make sure before a line starting with '#' that there are two blank lines
above it. Some already had this but many did not.

Change other things in todo.md file based on some things that have been
done (with corrections needed in some cases and otherwise the need to
verify no corrections are needed).

Typo fix in todo.md (swap a letter with a space).

I am aware that the todo.md is kind of a mess because of how it has been
updated. It would be helpful to have sections but this was meant to be a
quick update as it is more important to work on the things rather than
to organise the things that have to be done.
2023-11-02 05:47:34 -07:00
Cody Boone Ferguson dc57ef5c78 Add FAQ about mismatch of source/author remarks
This felt important because numerous times I have had to put in a
README.md file and/or the thanks file that state that the authors' or
author's remarks no longer apply and what should be done about it. These
should be located and either be removed or be synchronised (or even
refer to the FAQ?).
2023-10-29 03:33:27 -07:00
Cody Boone Ferguson 93963607f3 Many fixes and additions to 1984/mullender
Swap order of alt and original code in build/try sections so that the
original code is suggested second, after alt code, with the bugs and
(mis)features added to the README.md file, pointing out that it'll only
work on VAX-11 / PDP-11 machines. This is added in the bugs.md (it was
actually missing from the bugs.md file).

The alt code (both versions, see below) now have a lower limit on the
microseconds at 500 (still defaults at 10000). This is because anything
much lower and it's nigh impossible to see and in some cases it won't
work at all (at least in the MacBook Pro with the M1 chip).

Added second alt code which is like the first except that once it times
out it starts over.

Running make alt will compile both alt versions.

The gentab.c file that I added (found from the author) and fixed to
compile could not always create code that would compile due to some
characters needing to be escaped like ' and \. These are now escaped if
they are encountered but there certainly could be more that I did not
think of that would have to be escaped.
2023-10-27 03:51:17 -07:00
Cody Boone Ferguson 5fb33a9a91 Update FAQ about make diff_ rules + other fixes
I also fixed some other issues in the FAQ some to do with the entry
differences (from alt, orig and current) and some other things as well.
2023-10-24 04:39:33 -07:00
Landon Curt Noll 71f1463547 Rename diff Makefile commands
Renamed these Makefile rules:

    orig_prog_diff ==> diff_orig_prog
    alt_prog_diff ==> diff_alt_prog

Updated thanks-for-fixes.md and faq.md accordingly.
2023-10-22 17:26:22 -07:00
Cody Boone Ferguson 55d09331d7 Update FAQ about make diff rules
I have provided some examples as well and included how to use other diff
programs like colordiff. Checking formatting (including how it looks on
GitHub) and typo checks notwithstanding this entry is in good condition.
2023-10-19 05:51:49 -07:00
Cody Boone Ferguson 651f96b654 Add to FAQ about seeing fix changes
It seems to me that it is a good idea to show people how to see what
changed in order to get an entry to work in modern systems. I gave an
example where it's harder to tell because it's a very long line and an
example where it's easier to tell as it's not long lines but rather
shorter lines. Well it's easier to see on a line-by-line basis ..
whether it's easy to see what actually changed is probably another
matter entirely (especially since it's easier to see when you have
compiler errors in front of you) :-)
2023-10-17 07:20:42 -07:00
Cody Boone Ferguson 68aa94da20 Update FAQ about gets() -> fgets() change
I gave example output of a program where not changing it caused
confusing output, particularly in macOS, which is one of the strongest
reasons to make the change as it affects usability (in that it can make
one wonder what to do albeit probably briefly so).
2023-10-11 03:18:29 -07:00
Cody Boone Ferguson eb36bf870f Update link to cb man page
The link included in the previous commit was an older man page for the
tool.
2023-10-05 12:00:25 -07:00
Cody Boone Ferguson 137deeb528 Update FAQ about cb
As I thought it was indeed in unix but it seems to have vanished. I had
never seen it back then and it appears that only Plan 9 now has it. Plan
9, however, was never used for judging.

FAQ now links to Unix man page for cb.
2023-10-05 11:52:22 -07:00
Cody Boone Ferguson 4eb6e44713 Minor update to FAQ about clang defects
Simplified text a little bit.
2023-10-05 08:36:55 -07:00
Cody Boone Ferguson ef55fa8d7f Add item to FAQ about cb
Includes Plan 9 source code and a html rendered man page. If there was a
unix or linux version the code can no longer be found.

Some README.md files refer to this tool. When an author's remarks it
will not be removed or updated but if in the judges' remarks it might be
moved to a historical note subsection. This will happen in time with
additional passes of the README.md files - for most it should be the
final pass but the years 2011+ will need a pass before that.
2023-10-05 08:29:44 -07:00
Cody Boone Ferguson 1017f02589 Add note to FAQ about fgets() question
It is now noted that in some cases the fix can be as simple as adding
a macro so that the entry looks almost identical to the original. I gave
an example of 1988/reddy where all that had to be added was a
redefinition of gets.
2023-10-05 05:31:34 -07:00
Cody Boone Ferguson c1c8197c34 Add alt code to 1986/hague - fgets()
The reason it is in alt code is because one of the forms of input (see
below) will, although print out correct output, segfault after
outputting the text. That is when one does something like:

    echo foo | ./hague.alt

Whether it might be worth making it the entry itself with a note in the
Makefile and README.md and bugs.md (because it does print out correct
output) can be determined later - or not.

This change required several files to be updated besides the new file
hague.alt.c.
2023-10-04 04:09:38 -07:00
Cody Boone Ferguson 5f92b3d5ad Add FAQ about clang -Weverything being too strict
The prototype answer is from discussion on GitHub, suggested by Landon,
but I added to it and fixed typos as well. I probably introduced some
other problems at this hour and at least one thing comes to mind as
perhaps not ideal to have but these things can be worked out now that
they're in the file.
2023-10-04 02:19:39 -07:00
Cody Boone Ferguson bd1554d663 Add entries to FAQ + minor fixes to thanks file
The following entries were added:

0. Makefile rules.
1. 32-bit entries not working in 64-bit systems.
2. Some entries not working in macOS either uncompilable or
non-functional.
3. Entries that cannot be compiled with clang.

For (3) this especially is problematic for macOS as even /usr/bin/gcc is
clang (as has been noted many times before this but not in the FAQ).

At least one typo fix was also made and at least one entry that already
existed was updated a bit.

The fixes to the thanks file are related to the FAQ entries added.
2023-09-11 05:40:26 -07:00
Cody Boone Ferguson 9e2b569661 Update FAQ about incongruent code & author remarks
As I was looking at 2004/burley/README.md it occurred to me that
numerous entries have been modified in ways that are incongruent with
what the author(s) originally wrote about the entry. In some cases this
has been noted in the README.md file (like has been added to
2004/burley/README.md itself) but not in all. That should probably be
checked for and I will do that in time most likely but in the meantime
it felt even better to update the FAQ about this which this commit does
as well.
2023-09-10 09:58:27 -07:00
Cody Boone Ferguson 30d5e4f0e0 Add FAQ item and fix another
Note the .orig.c files.

I also fixed a minor issue in another question.
2023-07-10 10:08:25 -07:00
Cody Boone Ferguson 68e105b7c9 Add question/answer to faq.md
The question in question :-) is to do with the .orig.c files restored in
commit 2ba12ecc3c. This seems like a
useful FAQ entry to have.
2023-07-07 03:13:06 -07:00
Landon Curt Noll 3bb18c787c updated FAQ with first person plural question 2023-07-05 15:50:31 -07:00
Cody Boone Ferguson 24bf22fc4a Update faq.md
I added an entry on how to get sound entries to work under macOS (well
some already will work but some need SoX and I explained two ways to
install it - MacPorts and Homebrew).

I added an entry explaining where to find a list of entries with known
issues or things that appear to be issues but are rather features.

I also elaborated on some entries and I moved the terminal sanity (or
insanity :-) ) entry closer to the top as it seems like it is better to
help restore terminal sanity closer to the top as a messed up terminal
is very annoying.
2023-07-05 04:57:52 -07:00
Landon Curt Noll ac41f07a83 move fix thanks a file, update top level html links, rename CONTRIBUTING.md
The fix thank you's have been moved from `README.md` to
`thanks-for-fixes.md`.

**WARNING**: Some mistakes may have been made in doing this.
We presume later changes by others will correct any issues.

The `CONTRIBUTING.md` was renamed `how-to-enter.md`.

A 3rd line of links was added to top level html such as
`contact.html`, `index.html`, `judges.html`, `winners.html`,
and `years.html`.

Improved blank line use in a number (but not all) `README.md` files.
2023-06-06 16:59:53 -07:00
Cody Boone Ferguson a45ce1e47b Add missing state machine entries to faq.md
This is important as it's in the question about entries of themes that
are used a lot and thus that are less likely to win.
2023-06-06 02:51:00 -07:00
Cody Boone Ferguson 63136d41fc Improve documentation of installing SDL and SDL2
Remove how to install SDL1 / SDL2 from var.mk as it's already in faq.md.
Instead refer to faq.md. How to compile (variables etc.) is still in the
var.mk file.

Reworded that section a bit and added 'Other linux distributions'
subsection to 'Linux' (in faq.md).

Minor typo fix in faq.md at the same time as the above change. Normally
I would not do this but it's one word changed and I am too tired at this
time (or can't be bothered?) to do another pull request for one word.
2023-06-03 05:00:01 -07:00
Cody Boone Ferguson 9f34987616 Minor updates to faq.md
Add links, typo (kind of .. removed a dash) fix and clarify a point in
restoring terminal sanity.
2023-04-17 10:00:55 -07:00
Cody Boone Ferguson bb7c81e4f6 Add entry to faq.md about terminal sanity
In other words after running a curses program (ANSI escape codes can
also cause problems) the terminal can be quite insane; echo might be
disabled as a simpler example but many worse more annoying problems can
occur.

The simplest way is to run reset. This will restore everything though
it'll clear the screen (clear command will not fix any problems but just
clear the screen). For echo disabled stty echo should work. Sometimes
you can get away with doing stty sane.

Now these are in the faq.md. I wrote more about this in 2020/ferguson1
but that doesn't really matter other than it was the inspiration for
this entry (which I think is a good idea to include).
2023-04-13 06:12:48 -07:00
Cody Boone Ferguson 5fd9d73306 Update faq.md with more recent developments
Since fixes can be made via GitHub pull requests I updated the question
about finding bugs in entries, making sure to note that just because
someone has a fix does not mean that it'll be accepted (in fact I kind
of feel guilty about the fixes I have made except for entries that no
longer worked for one of the reasons noted in the FAQ entry).
2023-04-09 04:20:29 -07:00
Cody Boone Ferguson 9eb27e6dbf Update faq on rule 2 wrt fixing entries
It's very possible that in fixing entries rule 2 will be broken in some
entries. This should be noted in the faq as people might notice it and
find it dubious. The new entry now points out that when fixing entries
it's very possible that rule 2 could inadvertently be broken but the
originals can be seen in /archive.
2023-04-03 07:33:09 -07:00
Cody Boone Ferguson 513422054b Update 2018/giles + faq.md
Mostly this update is about SDL and SDL2 and how to compile and run
entries that make use of it. But I first saw reference to this idea in
2018/giles/README.md.

I added to macOS section MacPorts which is another very popular package
manager for macOS (I personally don't like Homebrew and I use MacPorts
instead).

Minor fixes in 2018/giles/README.md (formatting plus make a URL an
actual link).
2023-03-31 12:27:07 -07:00
Cody Boone Ferguson cdbf616f1e Fixes to 2018/mills/README.md
Typo fixes, formatting fixes and other things.

Updated faq.md with a note that this entry can also be used to run
1984/mullender.
2023-03-31 10:40:52 -07:00
Cody Boone Ferguson 5bdc4bba6f Add author comments to 1984/anonymous
Some years after the entry was published the judges asked them if they
wished to remain anonymous. They said yes but added that they are well
known for their there connection to the C language.

I fixed at the same time the typo that was in this quote as it seemed
that it's better to be clear than to keep a quote exactly as is
especially as it might have not been a copy paste in the first place.
2023-03-31 04:58:43 -07:00
Cody Boone Ferguson c2472c3eab Improve 1984/mullender alt code
Now you can specify the number of microseconds to sleep in between
writes! This makes it easier to experiment with different speeds as well
as solve any problems if your CPU is too slow or too fast

BTW: is there such a thing as too fast a CPU ? :-) actually yes for
certain code which is probably not as uncommon as you think :-) ).
2023-03-31 04:55:03 -07:00
Cody Boone Ferguson 99251402ef Improvements and fixes to faq.md
Format fixes (besides line lengths other formatting changes were made in
hopes to make things clearer / easier to see / better).

Reword some answers a bit to hopefully make them better.

Typo fixes here and there. There is one I'm not sure if it's meant to be
a typo or rather if I should change it since it's actually a quote: that
from 1984/anonymous. Thus I have not changed it.
2023-03-31 04:28:11 -07:00
Cody Boone Ferguson ef2828e9c1 Add alternative code for 1984/mullender for all!
Now anyone can enjoy 1984/mullender! This was a slight change to code
originally suggested in the faq (which was also updated, see below) made
for modern systems (since CPUs are much faster nowadays the duration for
usleep was much too long so one could not really enjoy the entry).

Updated bugs.md to remove this entry from the bugs.md file.

Also updated faq.md with another item. Unfortunately I had already added
another entry to faq.md and had failed to commit it before doing this
change (and adding it to the faq): how to get X11 entries (or actually
any X11 application) to work in macOS Mountain Lion and beyond. This is
why that faq entry is on this branch. It was not intended but it felt
like this change should be on its own branch / in a separate pull
request. I did not want to temporarily modify faq.md simply for this. I
have more changes to faq.md to make but that'll be on another branch so
that I have these changes there as well.
2023-03-31 04:06:10 -07:00
Cody Boone Ferguson a59162673c Add faq.md, remove faq.html
I tried to keep the formatting as close to the original as possible.
It's very likely links have to be fixed and it's very likely formatting
has to be fixed.

Some things necessarily had to change but very few did in fact need to
change.

As tempting as it was to change it to British English I did not (though
I started to when fixing a link but I caught myself in time) :-)

Naturally as this is a major change problems are expected but these will
be worked out. I guess the next step would be to do this for other raw
html files but I don't fancy doing more than one in a day. This can be
discussed later though as some will be automatically generated anyway so
no need for a markdown file (faq.md was discussed as a good idea).
2023-03-30 06:39:35 -07:00