diff --git a/man/HISTORY.md b/docs/HISTORY.md similarity index 100% rename from man/HISTORY.md rename to docs/HISTORY.md diff --git a/man/IMPLEMNT.md b/docs/IMPLEMNT.md similarity index 100% rename from man/IMPLEMNT.md rename to docs/IMPLEMNT.md diff --git a/man/MANUAL.md b/docs/MANUAL.md similarity index 100% rename from man/MANUAL.md rename to docs/MANUAL.md diff --git a/docs/README.md b/docs/README.md index f91417fc..5a6539d2 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,7 +1,42 @@ -PDCurses Web Site -================= +PDCurses Documentation +====================== -This directory contains the files for https://pdcurses.org/ . The main -documentation for PDCurses is now in [man]. +The main documentation for PDCurses is here: -[man]: ../man/README.md +- [User's Guide] - Basic overview +- [Implementor's Guide] - What you need to know to port PDCurses +- [Manual] - Each function, etc. +- [History] + +Also consult the README for each specific platform you'll be using: + +- [DOS] +- [OS/2] +- [SDL 1.x] +- [SDL 2.x] +- [Windows] +- [X11] + + +Building +-------- + +- To rebuild MANUAL.md from the "man page" sections of the source code, + type "./mkman.sh". Needs a Unix-like shell and a Python interpreter. + + +Distribution Status +------------------- + +The files in this directory are released to the public domain. + +[User's Guide]: USERS.md +[Implementor's Guide]: IMPLEMNT.md +[Manual]: MANUAL.md +[History]: HISTORY.md +[DOS]: ../dos/README.md +[OS/2]: ../os2/README.md +[SDL 1.x]: ../sdl1/README.md +[SDL 2.x]: ../sdl2/README.md +[Windows]: ../wincon/README.md +[X11]: ../x11/README.md diff --git a/man/USERS.md b/docs/USERS.md similarity index 100% rename from man/USERS.md rename to docs/USERS.md diff --git a/man/manext.awk b/docs/manext.awk similarity index 100% rename from man/manext.awk rename to docs/manext.awk diff --git a/man/mkman.sh b/docs/mkman.sh similarity index 100% rename from man/mkman.sh rename to docs/mkman.sh diff --git a/man/README.md b/man/README.md deleted file mode 100644 index 5a6539d2..00000000 --- a/man/README.md +++ /dev/null @@ -1,42 +0,0 @@ -PDCurses Documentation -====================== - -The main documentation for PDCurses is here: - -- [User's Guide] - Basic overview -- [Implementor's Guide] - What you need to know to port PDCurses -- [Manual] - Each function, etc. -- [History] - -Also consult the README for each specific platform you'll be using: - -- [DOS] -- [OS/2] -- [SDL 1.x] -- [SDL 2.x] -- [Windows] -- [X11] - - -Building --------- - -- To rebuild MANUAL.md from the "man page" sections of the source code, - type "./mkman.sh". Needs a Unix-like shell and a Python interpreter. - - -Distribution Status -------------------- - -The files in this directory are released to the public domain. - -[User's Guide]: USERS.md -[Implementor's Guide]: IMPLEMNT.md -[Manual]: MANUAL.md -[History]: HISTORY.md -[DOS]: ../dos/README.md -[OS/2]: ../os2/README.md -[SDL 1.x]: ../sdl1/README.md -[SDL 2.x]: ../sdl2/README.md -[Windows]: ../wincon/README.md -[X11]: ../x11/README.md