diff --git a/README.md b/README.md index 75f719f..68b70b8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,39 @@ # CodeBrowser -CodeBrowser allows you to... \ No newline at end of file + +## Overview + +CodeBrowser allows you to create a stand-alone HTML document with APL code. It's purpose is to provide a tool for documentation and code reviews. + +The HTML carries plenty of links. That makes it easy to jump around when reviewing code. + +The CSS is optimized for printing the document in order to make it look nice. + + +## Installation + +Make sure that the contents of the zip file goes into a folder that is scanned by Dyalog APL for user commands. + +Any newly started instance of Dyalog APL then knows a user commands `]CodeBrowser`. + +Enter + +``` +]?CodeBrowser +``` + +for how to run the user command (reference) + +For a detailed documentation including examples enter + +``` +]??CodeBrowser +``` + +The simplest example: + +``` +]CodeBrowser ⎕se -vib +``` + +The `-vib` flag stands for `wiew in browser`. This will allow you to see everything in `⎕SE`.