Skip to content

Commit

Permalink
Update README and example answerfile (#33)
Browse files Browse the repository at this point in the history
Signed-off-by: lbgracioso <[email protected]>
  • Loading branch information
lbgracioso authored Jan 5, 2024
1 parent 7e6c551 commit d183240
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ needed.

## Major features to be implemented

* Command line arguments for unattended installation.
* Unattended answer file via `.conf` file on user homedir or predefined
location.
* Localization support.
* Always running daemon to ease cluster maintenance.
* Static binaries.
Expand Down Expand Up @@ -115,10 +112,6 @@ preliminar testing.
We recommend to build and run this software in a virtual machine due to its
nature and `root` execution requirements.

## Running tests

To run tests you need to run `ctest` inside the build directory.

### Recommended VM settings

* EL8 based system with **minimal** package selection
Expand Down Expand Up @@ -150,12 +143,22 @@ Finally, to build the software just run the commands:
$ cmake --build ./build
```

Resulting binary will be available on `bin` directory in the root directory of
Resulting binary will be available on `/build/src` directory in the root directory of
the project.

As a final warning: running the software without **DUMMY** option will probably
damage the running OS if they run as **root**. Be advised.

You can run it by calling `./binary_name -t` (TUI - Terminal User Interface) or
by using a `answerfile` and CLI (Command Line Interface) with
`./binary_name -a /path/to/answerfile`.

If you require any further help, please use `./binary_name -h` (-h, --help).

### Running tests

To run tests you need to run `ctest` inside the build directory.

# Open Source Apache License

CloysterHPC is made available under
Expand Down
3 changes: 2 additions & 1 deletion example.answerfile.ini
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ [email protected]
[time]
timezone=America/Sao_Paulo
timeserver=0.br.pool.ntp.org
locale=en_US.UTF-8
# "locale" must be one of the locales informed by `locale -a` shell command
locale=en_US.utf8

[hostname]
hostname=cloyster
Expand Down

0 comments on commit d183240

Please sign in to comment.