Skip to content

Commit

Permalink
Update the README.md with install/configuration details
Browse files Browse the repository at this point in the history
  • Loading branch information
WilliamMcCumstie committed Apr 22, 2020
1 parent 3f17638 commit 6b5fdb1
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
etc/config.yaml
var
.bundle
vendor
bin/*-with-config
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,43 @@ Manage Alces Flight Center Assets

## Overview

This command line utility manages Alces Flight Center assets including the following:
* View and list the assets, groups, and categories,
* Create a new asset,
* Modify the asset's support type, and
* Decommission assets and groups.

## Installation

The application requires a modern(ish) version of `ruby`/`bundler`. It has been designed with the following versions in mind:
* centos7
* ruby 2.6.1
* bundler 1.17.3

After downloading the source code (via git or other means), the gems need to be installed using bundler:

```
cd /path/to/source
bundle install --with default --without development --path vendor
```

## Configuration

By default this application will look for `etc/config.yaml` as its configuration file. This config can be easily created using the `wizard` utility. It is not possible to exit the wizard until all the `REQUIRED` flags have been provided (see `wizard --help` for details). The `--finished` flag will exit the wizard after all the required flags have been provided.

```
# The the list of required configuration flags
bin/flight-asset wizard --help
# Example command setting configs
# NOTE: The --finished flag is required to exit the wizard
bin/flight-asset wizard --jwt foo --component-id bar --finished
```

## Operation

WIP

# Contributing

Fork the project. Make your feature addition or bug fix. Send a pull
Expand Down

0 comments on commit 6b5fdb1

Please sign in to comment.