Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
damienbutt committed Jul 29, 2024
1 parent 6890311 commit 427619e
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 49 deletions.
21 changes: 7 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,15 +226,12 @@ If you would like to use a different location to store the global configuration
"buildWithDebugInformation": false,
"buildWithSource": false,
"includePath": [
"C:\\Program Files (x86)\\Common Files\\AMXShare\\AXIs",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\includes"
"C:\\Program Files (x86)\\Common Files\\AMXShare\\AXIs"
],
"modulePath": [
"C:\\Program Files (x86)\\Common Files\\AMXShare\\Duet\\bundle",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\monitors",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\monitors-duet",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\monitors-netlinx"
"C:\\Program Files (x86)\\Common Files\\AMXShare\\Duet\\lib",
"C:\\Program Files (x86)\\Common Files\\AMXShare\\Duet\\module"
],
"libraryPath": [
"C:\\Program Files (x86)\\Common Files\\AMXShare\\SYCs"
Expand All @@ -247,8 +244,7 @@ If you would like to use a different location to store the global configuration
"includeCompiledModuleFiles": true,
"includeFilesNotInWorkspace": true,
"extraFileSearchLocations": [
"C:\\Program Files (x86)\\Common Files\\AMXShare",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18"
"C:\\Program Files (x86)\\Common Files\\AMXShare"
],
"extraFileArchiveLocation": ".genlinx",
"all": false,
Expand Down Expand Up @@ -279,15 +275,12 @@ If you would like to use a different location to store the global configuration
"libraryPath": "-L"
},
"includePath": [
"C:\\Program Files (x86)\\Common Files\\AMXShare\\AXIs",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\includes"
"C:\\Program Files (x86)\\Common Files\\AMXShare\\AXIs"
],
"modulePath": [
"C:\\Program Files (x86)\\Common Files\\AMXShare\\Duet\\bundle",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\monitors",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\monitors-duet",
"C:\\Program Files\\AMX\\Resource Management Suite\\SDK\\NetLinx\\4.7.18\\monitors-netlinx"
"C:\\Program Files (x86)\\Common Files\\AMXShare\\Duet\\lib",
"C:\\Program Files (x86)\\Common Files\\AMXShare\\Duet\\module"
],
"libraryPath": [
"C:\\Program Files (x86)\\Common Files\\AMXShare\\SYCs"
Expand Down
33 changes: 2 additions & 31 deletions docs/genlinx.1
Original file line number Diff line number Diff line change
@@ -1,26 +1,6 @@
.\" Automatically generated by Pandoc 2.19.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "GENLINX" "1" "September 2022" "genlinx 0.0.0-development" ""
.hy
.SH NAME
.PP
genlinx - an open source CLI tool for NetLinx projects
genlinx \- an open source CLI tool for NetLinx projects
.SH SYNOPSIS
.PP
\f[B]genlinx\f[R] [\f[I]CMD\f[R]] [\f[I]OPTIONS\f[R]]
.PD 0
.P
Expand All @@ -37,12 +17,7 @@ genlinx - an open source CLI tool for NetLinx projects
.PD 0
.P
.PD
\f[B]genlinx config\f[R] [\f[I]OPTIONS\f[R]]
.PD 0
.P
.PD
.SH DESCRIPTION
.PP
\f[B]genlinx\f[R] is a CLI helper tool for work with NetLinx Studio
projects
.SH EXAMPLES
Expand All @@ -57,11 +32,9 @@ Success
\f[B]!0\f[R]
Failure
.SH BUGS
.PP
More then likely.
.SH COPYRIGHT
.PP
Copyright (C) 2023 Norgate AV Services Limited
Copyright (C) 2024 Norgate AV Services Limited
.PP
The MIT License (MIT)
.PP
Expand All @@ -83,5 +56,3 @@ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.SH AUTHORS
Norgate AV Services Limited
7 changes: 3 additions & 4 deletions docs/genlinx.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% GENLINX(1) genlinx 0.0.0-development
% GENLINX(1) genlinx 2.2.3
% Norgate AV Services Limited
% September 2023
% July 2024

# NAME

Expand All @@ -12,7 +12,6 @@ genlinx - an open source CLI tool for NetLinx projects
**genlinx archive** [*OPTIONS*]\
**genlinx build** [*OPTIONS*]\
**genlinx cfg** [*OPTIONS*]\
**genlinx config** [*OPTIONS*]\

# DESCRIPTION

Expand All @@ -37,7 +36,7 @@ More then likely.

# COPYRIGHT

Copyright (C) 2023 Norgate AV Services Limited
Copyright (C) 2024 Norgate AV Services Limited

The MIT License (MIT)

Expand Down

0 comments on commit 427619e

Please sign in to comment.