Moved the docs from "man" to "docs". The docs/man thing was too confusing.

This commit is contained in:
William McBrine
2019-08-25 02:02:59 -04:00
parent ed3963cfbd
commit 717d4e001d
8 changed files with 40 additions and 47 deletions

View File

@@ -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

View File

@@ -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