From db923bd3e02f9332c654c2cc3fb9eed968117429 Mon Sep 17 00:00:00 2001 From: William McBrine Date: Fri, 14 Jan 2022 14:55:33 -0500 Subject: [PATCH] Doc re-org -- index no longer needed --- docs/CNAME => CNAME | 0 README.md | 88 ++++++++++++++++++++++++++------------------ docs/README.md | 3 -- docs/favicon.ico | Bin 318 -> 0 bytes docs/index.md | 42 --------------------- 5 files changed, 52 insertions(+), 81 deletions(-) rename docs/CNAME => CNAME (100%) delete mode 100644 docs/favicon.ico delete mode 100644 docs/index.md diff --git a/docs/CNAME b/CNAME similarity index 100% rename from docs/CNAME rename to CNAME diff --git a/README.md b/README.md index 35d3f63b..519e2a82 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,47 @@ -Welcome to PDCurses! -==================== +PDCurses +======== + +Stable: [v3.9] +Beta: [See git repository][git] + +PDCurses is a public domain curses library for [DOS], [OS/2], [Windows] +console, [X11] and [SDL], implementing most of the functions available +in [X/Open][xopen] and System V R4 curses. It supports many compilers +for these platforms. The X11 port lets you recompile existing text-mode +curses programs to produce native X11 applications. + +PDCurses is distributed mainly as source code, but some pre-compiled +libraries may be available. See the [downloads page] for a list. -PDCurses is an implementation of X/Open curses for multiple platforms. The latest version can be found at: - https://pdcurses.org/ + For changes, see the [History] file. The main documentation is now in the [docs] directory. +Mailing lists +------------- + +There's a low-traffic mailing list for announcements and discussion. To +subscribe, email the [list server], with the first line of the body of +the message containing: + +`subscribe pdcurses-l` + +or you can read the mailing list [archive]. + + +Other links +----------- + +* [Docs][docs] +* [GitHub Page][git] +* [SourceForge Page] +* [X/Open curses][xopen] + + Legal Stuff ----------- @@ -18,48 +50,32 @@ are subject to copyright under various licenses. Each directory contains a README.md file, with a section titled "Distribution Status" which describes the status of the files in that directory. -If you use PDCurses in an application, an acknowledgement would be -appreciated, but is not mandatory. If you make corrections or -enhancements to PDCurses, please forward them to the current maintainer -for the benefit of other users. - This software is provided AS IS with NO WARRANTY whatsoever. -Ports ------ - -PDCurses has been ported to DOS, OS/2, Windows, X11 and SDL. A directory -containing the port-specific source files exists for each of these -platforms. - -Build instructions are in the README.md file for each platform: - -- [DOS] -- [OS/2] -- [SDL 1.x] -- [SDL 2.x] -- [Windows] -- [X11] - - -Distribution Status -------------------- - -All files in this directory (not including subdirectories) are released -to the public domain. - - Maintainer ---------- -William McBrine +[William McBrine] + + +[v3.9]: https://github.com/wmcbrine/PDCurses/releases/tag/3.9 +[git]: https://github.com/wmcbrine/PDCurses [History]: docs/HISTORY.md [docs]: docs/README.md +[downloads page]: https://sourceforge.net/projects/pdcurses/files/ + +[list server]: mailto:majordomo@lightlink.com +[archive]: https://www.mail-archive.com/pdcurses-l@lightlink.com/ + +[SourceForge Page]: https://sourceforge.net/projects/pdcurses +[xopen]: https://pubs.opengroup.org/onlinepubs/007908799/cursesix.html + [DOS]: dos/README.md [OS/2]: os2/README.md -[SDL 1.x]: sdl1/README.md -[SDL 2.x]: sdl2/README.md +[SDL]: sdl2/README.md [Windows]: wincon/README.md [X11]: x11/README.md + +[William McBrine]: https://wmcbrine.com/ diff --git a/docs/README.md b/docs/README.md index 3a96ff6d..5a6539d2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -17,9 +17,6 @@ Also consult the README for each specific platform you'll be using: - [Windows] - [X11] -This directory also contains the files, CNAME and index.html, that -create pdcurses.org, via GitHub. - Building -------- diff --git a/docs/favicon.ico b/docs/favicon.ico deleted file mode 100644 index f05cc9521d3fb9b411a20323cbb18e0129d772a1..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 318 zcmc(ZyAc903`C!2t^h}*5MEd0rU?%bRdB7S2MVAKz=7Gd0}}F+v>!{Jksv8^&N$Wt z2dm)DNk}YWh{6A;f{I$Fh-HZgsRw-&z1s;&w@f?7Rr@b@DAMwPo788uBYd6{?F{ej K=lyo diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 9e22662d..00000000 --- a/docs/index.md +++ /dev/null @@ -1,42 +0,0 @@ -PDCurses -======== - -Stable: [v3.9] -Beta: [See git repository][git] - -PDCurses is a public domain curses library for DOS, OS/2, Windows -console, X11 and SDL, implementing most of the functions available in -X/Open and System V R4 curses. It supports many compilers for these -platforms. The X11 port lets you recompile existing text-mode curses -programs to produce native X11 applications. - -PDCurses is distributed mainly as source code, but some pre-compiled -libraries may be available. See the [downloads page] for a list. - -There's a low-traffic mailing list for announcements and discussion. To -subscribe, email the [list server], with the first line of the body of -the message containing: - -`subscribe pdcurses-l` - -or you can read the mailing list [archive]. - - -Other links ------------ - -* [Docs] -* [GitHub Page][git] -* [SourceForge Page] -* [X/Open Curses][xopen] - - -[v3.9]: https://github.com/wmcbrine/PDCurses/releases/tag/3.9 -[git]: https://github.com/wmcbrine/PDCurses -[downloads page]: https://sourceforge.net/projects/pdcurses/files/ -[list server]: mailto:majordomo@lightlink.com -[archive]: https://www.mail-archive.com/pdcurses-l@lightlink.com/ - -[Docs]: https://github.com/wmcbrine/PDCurses/blob/master/docs/README.md -[SourceForge Page]: https://sourceforge.net/projects/pdcurses -[xopen]: https://pubs.opengroup.org/onlinepubs/007908799/cursesix.html