zii/MRCI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated the documentation

Browse Source 
Updated all documentation related to the changes made in the previous
commit.
This commit is contained in:
Maurice ONeal 2019-09-26 22:00:51 -04:00
parent 364924c383
commit 73409ca26e
3 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Internal_Commands.md
View File

@ -66,6 +66,8 @@ The host is extendable via 3rd party modules but the host itself have it's own i
* [fs_move](intern_commands/fs_move.md) - move/rename a file system object (file,directory,symlink) from one location to another. * [fs_move](intern_commands/fs_move.md) - move/rename a file system object (file,directory,symlink) from one location to another.
* [fs_tree](intern_commands/fs_tree.md) - list all files and sub-directories of an entire directory tree.
* [fs_upload](intern_commands/fs_upload.md) - upload a single file to the host. * [fs_upload](intern_commands/fs_upload.md) - upload a single file to the host.
* [host_config](intern_commands/host_config.md) - view/change various host settings. * [host_config](intern_commands/host_config.md) - view/change various host settings.

6
docs/README.md
View File

@ -68,7 +68,7 @@ makeself
Linux_build.sh is a custom script designed to build this project from the source code using qmake, make and makeself. You can pass 2 optional arguments: Linux_build.sh is a custom script designed to build this project from the source code using qmake, make and makeself. You can pass 2 optional arguments:
1. The path to the QT bin folder in case you want to compile with a QT install not defined in PATH. 1. The path to the QT bin folder in case you want to compile with a QT install not defined in PATH.
2. Path of the output makeself file (usually has a .run extension). If not given, the outfile will be named mrci-1.1.2.run in the source code folder. 2. Path of the output makeself file (usually has a .run extension). If not given, the outfile will be named mrci-x.x.x.run in the source code folder.
Build: Build:
``` ```
@ -77,8 +77,8 @@ sh ./linux_build.sh
``` ```
Install: Install:
``` ```
chmod +x ./mrci-1.1.2.run chmod +x ./mrci-x.x.x.run
./mrci-1.1.2.run ./mrci-x.x.x.run
``` ```
The makeself installer not only installs the application but also installs it as a service if the target linux system supports systemd. The makeself installer not only installs the application but also installs it as a service if the target linux system supports systemd.

4
src/int_loader.cpp
View File

@ -26,7 +26,7 @@ InternalCommandLoader::InternalCommandLoader(RWSharedObjs *sharedData, QObject *
// This is used as an automated way to update the Internal_Commands doc for the source code documentation // This is used as an automated way to update the Internal_Commands doc for the source code documentation
// keep it commented for release code. // keep it commented for release code.
// makeDocHeader("/path/to/source/docs/Internal_Commands.md"); //makeDocHeader("/docs/Internal_Commands.md");
objNames << CloseHost::cmdName(); objNames << CloseHost::cmdName();
objNames << RestartHost::cmdName(); objNames << RestartHost::cmdName();
@ -307,7 +307,7 @@ InternCommand *InternalCommandLoader::cmdObj(const QString &name)
// This is used as an automated way to update the Internal_Commands doc for the source code documentation // This is used as an automated way to update the Internal_Commands doc for the source code documentation
// keep it commented for release code. // keep it commented for release code.
// appendToDoc("/path/to/source/docs/Internal_Commands.md", name, ret); //appendToDoc("/docs/Internal_Commands.md", name, ret);
} }
} }
else else