From aefd6d0a7b873d4491550d4c4b3360c1b3510a28 Mon Sep 17 00:00:00 2001 From: "Michael B. E. Rickert" Date: Sun, 28 Jun 2015 17:28:17 -0700 Subject: [PATCH] Merge OVERVIEW.txt into README, reformat README.txt as .md, transfer TODO.txt into github issues. --- OVERVIEW.txt | 30 ------------------ README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.txt | 45 --------------------------- TODO.txt | 3 -- 4 files changed, 86 insertions(+), 78 deletions(-) delete mode 100644 OVERVIEW.txt create mode 100644 README.md delete mode 100644 README.txt delete mode 100644 TODO.txt diff --git a/OVERVIEW.txt b/OVERVIEW.txt deleted file mode 100644 index 4abfa1b9..00000000 --- a/OVERVIEW.txt +++ /dev/null @@ -1,30 +0,0 @@ - - - - PROJECT LAYOUT - - - PuttyDLL is a native C project which is almost a direct replica of PUTTY.DSP project from the official PuTTY source code. - Key differences: -It's been converted to a VS2008 project via the upgrade manager (which worked flawlessly) -It now generates DLLs instead of EXEs -_*_SECURE_NO_DEPRECATE have been added to supress warning spam from standard library functions -export.c has been added which exposes methods for PuttySharp (C#) to PInvoke -Other source files may be modified to expose more to export.c -- should be mostly cosmetic/making availbe outside the TU - - - PuttySharp is a C# library which wraps the methods exposed by PuttyDLL for easier consumption in C# -It is currently small enough that it ended up well commented and designed. This probably won't last very long. - - - ShinyConsole is a C# program which provides and tests SlimDX/D3D9 based console text rendering -It is crufty and in need of sanitization. -It is used as a library by TtyPlayer, despite being a program. - - - TtyRecMonkey is the main C# program which is the point of this project. It is not well written. - It currently handles: -Parsing (to be spin off?) of TtyRecs -Basic playback of TtyRecs - - diff --git a/README.md b/README.md new file mode 100644 index 00000000..82a60960 --- /dev/null +++ b/README.md @@ -0,0 +1,86 @@ +# Quickstart + +Please read [LICENSE.txt](https://github.com/MaulingMonkey/TtyRecMonkey/blob/master/LICENSE.txt) for license terms + +## Downloads + +See the latest [Releases](https://github.com/MaulingMonkey/TtyRecMonkey/releases) + +## Placeholder Controls + +ZXCVBNM Alter playback speed (-100x, -10x, -1x, 0x, +1x, +10x, +100x) +AS Zoom In/Out + +## Contact + +- The author can also be contacted in the IRC channel #gamedev on irc.afternet.org under the alias MaulingMonkey +- File github issues, I don't mind :) + + + +# Development + +## Dependencies + +- Visual Studio 2008 ( no solution for Express, sorry ) +- [SlimDX Developer SDK](http://slimdx.org/download.php) +- Direct3D9 + +## Grabbing the Source + +You can browse and observe project development at https://github.com/MaulingMonkey/TtyRecMonkey + +If you simply want to track changes, read only git access is available at: +``` + git clone git://github.com/MaulingMonkey/TtyRecMonkey.git + svn checkout http://svn.github.com/MaulingMonkey/TtyRecMonkey.git +``` + +## Building the Source + +- Open TtyRecMonkey.sln +- Build it. +- Select the project TtyRecMonkey and make it your startup project before running. + - Alternatively, launch bin\x86\Debug\TtyRecMonkey.exe or bin\x86\Release\TtyRecMonkey.exe +- Select a non-compressed ttyrec file and open it + +## Project Layout + +### PuttyDLL + + PuttyDLL is a native C project which is almost a direct replica of PUTTY.DSP project from the official PuTTY source code. + + Key differences: + +- It's been converted to a VS2008 project via the upgrade manager (which worked flawlessly) +- It now generates DLLs instead of EXEs +- _*_SECURE_NO_DEPRECATE have been added to supress warning spam from standard library functions +- export.c has been added which exposes methods for PuttySharp (C#) to PInvoke +- Other source files may be modified to expose more to export.c -- should be mostly cosmetic/making availbe outside the TU + + +### PuttySharp + + PuttySharp is a C# library which wraps the methods exposed by PuttyDLL for easier consumption in C# + +It is currently small enough that it ended up well commented and designed. This probably won't last very long. + + +### ShinyConsole + + ShinyConsole is a C# program which provides and tests SlimDX/D3D9 based console text rendering + +It is crufty and in need of sanitization. + +It is used as a library by TtyPlayer, despite being a program. + + + +### TtyRecMonkey + + TtyRecMonkey is the main C# program which is the point of this project. It is not well written. + + It currently handles: + +- Parsing (to be spin off?) of TtyRecs +- Basic playback of TtyRecs \ No newline at end of file diff --git a/README.txt b/README.txt deleted file mode 100644 index 5d229f46..00000000 --- a/README.txt +++ /dev/null @@ -1,45 +0,0 @@ - - - -Please read LICENSE.txt for license terms - - - -==== Quick External Requirements ==== - -Visual Studio 2008 ( no solution for Express, sorry ) -SlimDX Developer SDK ( http://slimdx.org/download.php ) -Direct3D9 - - - -==== Getting Started ==== - -Open TtyRecMonkey.sln -Build it. - -Select the project TtyRecMonkey and make it your startup project before running. -Alternatively, launch bin\x86\Debug\TtyRecMonkey.exe or bin\x86\Release\TtyRecMonkey.exe - -Select a non-compressed ttyrec file and open it - - - -==== Placeholder Controls ==== - -ZXCVBNM Alter playback speed (-100x, -10x, -1x, 0x, +1x, +10x, +100x) -AS Zoom In/Out - - - -==== Development ==== - -You can browse and observe project development at https://github.com/MaulingMonkey/TtyRecMonkey - -If you simply want to track changes, read only git access is available at: - git clone git://github.com/MaulingMonkey/TtyRecMonkey.git - svn checkout http://svn.github.com/MaulingMonkey/TtyRecMonkey.git - -An overview of the project layout can be found under OVERVIEW.txt -Details about the near term goals of the project can be found under TODO.txt -The author can also be contacted in the IRC channel #gamedev on irc.afternet.org under the alias MaulingMonkey diff --git a/TODO.txt b/TODO.txt deleted file mode 100644 index 46d4961b..00000000 --- a/TODO.txt +++ /dev/null @@ -1,3 +0,0 @@ -- Replay search feature -- Better UI for seek/speed/etc -- TtyRec appending?