From: Michael D. Lowis Date: Fri, 14 Feb 2020 21:26:25 +0000 (-0500) Subject: convert to asciidoc X-Git-Url: https://git.mdlowis.com/?a=commitdiff_plain;h=ed26465c7468f89b171cebd12b0672befa5daf4e;p=projs%2Ftide.git convert to asciidoc --- diff --git a/.gitignore b/.gitignore index 9b79770..72d7c2e 100644 --- a/.gitignore +++ b/.gitignore @@ -60,3 +60,4 @@ pick tidehtml/ plantuml.jar html/ +bin/tide diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..453f7b8 --- /dev/null +++ b/README.adoc @@ -0,0 +1,119 @@ += Readme + +A minimal text editor inspired by the Acme text editor from Plan 9. + +== Building + +*Build Prerequisites:* + +* A Unix-like environment +* Ruby 2.5.1 or greater + +Execute the following command to produce all of the binaries into bin/: + +make + +== Installation + + # optionally set the prefix for where it will be installed (*Default:* /usr/local/) + export PREFIX=$HOME + + # build and install + make install + +== Usage + + edit file1 file 2 file3 + +== System Overview + +=== Use Case: Editing a file that is not already open +@startuml +actor User +User -> Edit : edit foo.txt +Edit -> Registrar : foo.txt +Registrar -> Edit : Not open +Edit -> Tide : tide foo.txt +Edit -> User : Success +@enduml + +=== Use Case: Editing a file that is already open +@startuml +actor User +User -> Edit : edit foo.txt +Edit -> Registrar : foo.txt +Registrar -> Tide : Focus window +Registrar -> Edit : Open already +Edit -> User : Success +@enduml + +=== Use Case: Editing a file at a specific line number +@startuml +actor User +User -> Edit : edit foo.txt:42 +Edit -> Registrar : foo.txt:42 +Registrar -> Tide : Focus window +Registrar -> Tide : Goto line 42 +Registrar -> Edit : Open already +Edit -> User : Success +@enduml + +== Executable Overview + +=== Compiled Executables + +|=== +| *Executable* | *Description* + +| link:src/edit.adoc[edit] + | Main executable used to open files for editing +| link:src/fetch.adoc[fetch] + | Executes pattern matching rules on input text +| link:src/fetch.adoc[fetchsel] + | Executes pattern matching rules on selected text +| link:src/pick.adoc[pick] + | Performs fuzzy search on a set of strings +| link:src/registrar.adoc[registrar] + | Tracks open windows and the files they contain +| link:src/tide.adoc[tide] + | The main tide editor executable +|=== + +=== Helper Scripts + +|=== +| *Executable* | *Description* + +| link:docs/c_scripts.md[E-S and S-E] + | Convert C functions between static and extern scoping +| link:docs/edit_scripts.md[c+ and c-] + | Comment and uncomment selected text +| link:docs/pick_scripts.md[fcomplete] + | Uses @ref pick to complete a file or directory path +| link:docs/edit_scripts.md[findall] + | Find all occurrences of a string in the project or directory +| link:docs/edit_scripts.md[grepn] + | Executes grep -n on input and outputs to a new window +| link:docs/edit_scripts.md[i+ and i-] + | Indent or deindent input text +| link:docs/c_scripts.md[jmpsrc] + | Jump between related C source and header files +| link:docs/edit_scripts.md[lang] + | Determine by extension the programming language of source file +| link:docs/c_scripts.md[no-c++] + | Convert all C++ style comments to C style comments +| link:docs/pick_scripts.md[pickexec] + | Uses @ref pick to find and execute an command in $PATH +| link:docs/pick_scripts.md[pickfile] + | Uses @ref pick to find and open a file for editing +| link:docs/pick_scripts.md[picktag] + | Uses @ref pick to jump to a symbol using CTags index file +| link:docs/edit_scripts.md[term] + | Executes command shell in @ref tide in pseudo-terminal mode +| link:docs/c_scripts.md[tofn] + | Converts C function prototypes to function definitions +| link:docs/debugging.md[view-telem] + | Prints @ref tide telemetry data to stdout for debugging +| link:docs/edit_scripts.md[w+ and x+] + | Marks the current file as writable and/or executable +|=== diff --git a/README.md b/README.md deleted file mode 100644 index faf16e3..0000000 --- a/README.md +++ /dev/null @@ -1,93 +0,0 @@ -# Readme - -A minimal text editor inspired by the Acme text editor from Plan 9. - -## Building - -**Build Prerequisites:** - -* A Unix-like environment -* Ruby 2.5.1 or greater - -Execute the following command to produce all of the binaries into bin/: - - make - -## Installation - - # optionally set the prefix for where it will be installed (*Default:* /usr/local/) - export PREFIX=$HOME - - # build and install - make install - -## Usage - - edit file1 file 2 file3 - -## System Overview - -### Use Case: Editing a file that is not already open -@startuml -actor User -User -> Edit : edit foo.txt -Edit -> Registrar : foo.txt -Registrar -> Edit : Not open -Edit -> Tide : tide foo.txt -Edit -> User : Success -@enduml - -### Use Case: Editing a file that is already open -@startuml -actor User -User -> Edit : edit foo.txt -Edit -> Registrar : foo.txt -Registrar -> Tide : Focus window -Registrar -> Edit : Open already -Edit -> User : Success -@enduml - -### Use Case: Editing a file at a specific line number -@startuml -actor User -User -> Edit : edit foo.txt:42 -Edit -> Registrar : foo.txt:42 -Registrar -> Tide : Focus window -Registrar -> Tide : Goto line 42 -Registrar -> Edit : Open already -Edit -> User : Success -@enduml - -## Executable Overview - -### Compiled Executables - -| Executable | Description | -|-----------------------|--------------------------------------------------| -| @ref edit | Main executable used to open files for editing | -| @ref fetch | Executes pattern matching rules on input text | -| @ref fetch "Fetchsel" | Executes pattern matching rules on selected text | -| @ref pick | Performs fuzzy search on a set of strings | -| @ref registrar | Tracks open windows and the files they contain | -| @ref tide | The main tide editor executable | - -### Helper Scripts - -| Executable | Description | -|-----------------------------------|----------------------------------------------------------------| -| [E-S and S-E](docs/c_scripts.md) | Convert C functions between static and extern scoping | -| [c+ and c-](docs/edit_scripts.md) | Comment and uncomment selected text | -| [fcomplete](docs/pick_scripts.md) | Uses @ref pick to complete a file or directory path | -| [findall](docs/edit_scripts.md) | Find all occurrences of a string in the project or directory | -| [grepn](docs/edit_scripts.md) | Executes grep -n on input and outputs to a new window | -| [i+ and i-](docs/edit_scripts.md) | Indent or deindent input text | -| [jmpsrc](docs/c_scripts.md) | Jump between related C source and header files | -| [lang](docs/edit_scripts.md) | Determine by extension the programming language of source file | -| [no-c++](docs/c_scripts.md) | Convert all C++ style comments to C style comments | -| [pickexec](docs/pick_scripts.md) | Uses @ref pick to find and execute an command in $PATH | -| [pickfile](docs/pick_scripts.md) | Uses @ref pick to find and open a file for editing | -| [picktag](docs/pick_scripts.md) | Uses @ref pick to jump to a symbol using CTags index file | -| [term](docs/edit_scripts.md) | Executes command shell in @ref tide in pseudo-terminal mode | -| [tofn](docs/c_scripts.md) | Converts C function prototypes to function definitions | -| [view-telem](docs/debugging.md) | Prints @ref tide telemetry data to stdout for debugging | -| [w+ and x+](docs/edit_scripts.md) | Marks the current file as writable and/or executable |