Skip to content

Commit 280f055

Browse files
committed
updating README for release
1 parent 0d134e0 commit 280f055

File tree

1 file changed

+27
-21
lines changed

1 file changed

+27
-21
lines changed

README.md

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,30 @@
22

33
A command line helper when you need it.
44

5+
![docs/assets/img/interface.png](docs/assets/img/interface.png)
6+
7+
# Overview
8+
9+
HelpMe is a general tool that can support the addition of helpers, or different
10+
modules that have a set of metadata to collect for the user, and based on an internal
11+
configuration file to define these metadata, and (if needed) an external config file
12+
for user variables, we send help requests to the various helpers. For example:
13+
14+
- `helpme github` posts an issue on a Github board
15+
- `helpme uservoice` creates a ticket on uservoice
16+
17+
Please [post issues](https://www.github.com/vsoch/helpme/issues)
18+
with questions, feedback, or just to say hello, and see our [complete documentation here](https://vsoch.github.io/helpme).
19+
20+
21+
# Background
22+
523
Asking for help is a standard need for research software users, and needing to perform this function from a command line is common given the headless environments provided on shared cluster resources. While interactive web interfaces are the main avenue to submit help tickets and issues to get help, they are many steps away from the original command line where the issue arose, meaning that the user must interrupt a workflow, navigate to another program, and perform several clicks before needing to try to manually capture the problem at hand. At best, the user might copy an error message and the support staff then needs to ask or use internal resources to collect more information. This reality is not ideal because the user often presents a limited summary of the issue, and valuable information about the system, environment, or even a recording of the actual issue are lost. Extra time is spent on further communication and effort to obtain this information. HelpMe resolves these issues by recording information about the issue directly from the source, and allowing users to ask for help without leaving the working environment.
624

725
HelpMe is a free to use, open source command line tool that serves one purpose: to connect a user on a command line to a a resource to get help. The software provides a general framework for developers to add "helpers," or different support endpoints to work with "recorders," each a specific way of capturing information like messages, terminal recordings (asciinema), and environment, to easily submit to the endpoint. Importantly, the complex interaction of various application programming interfaces (APIs) with the user's terminal is presented in a simple and intuitive way that puts the user in control of the interaction. By default, the software comes ready to use for interaction with Github and the UserVoice ticketing softwarecommonly used in Research Computing. The HelpMe [documentation base](https://vsoch.github.io/helpme) is rendered from the same repository and open for contribution. It provides ample detail for developers to add new helpers, recorders, and for users to install the software.
826

9-
![docs/assets/img/interface.png](docs/assets/img/interface.png)
27+
28+
# Installation
1029

1130
## Local
1231

@@ -18,48 +37,35 @@ pip install helpme[uservoice]
1837

1938
## Docker
2039

21-
```bash
22-
$ docker build -t vanessa/helpme .
23-
```
24-
25-
### Interactive Development
40+
You can use the image built on Docker Hub directory
2641

2742
```bash
2843
$ docker run -it --entrypoint bash vanessa/helpme
2944
```
3045

31-
# Overview
46+
or you can build it from this repository!
3247

33-
HelpMe is a general tool that can support the addition of helpers, or different
34-
modules that have a set of metadata to collect for the user, and based on an internal
35-
configuration file to define these metadata, and (if needed) an external config file
36-
for user variables, we send help requests to the various helpers. For example:
37-
38-
- `helpme github` posts an issue on a Github board
39-
- `helpme uservoice` creates a ticket on uservoice
40-
41-
We are fresh out of the oven! Please [post issues](https://www.github.com/vsoch/helpme/issues)
42-
with questions, feedback, or just to say hello. Hello!
48+
```bash
49+
$ docker build -t vanessa/helpme .
50+
```
4351

4452
# Usage
4553

4654
```bash
47-
4855
# Post an issue to a Github Repo.
4956
$ helpme github vsoch/helpme
5057

5158
# Post a ticket to UserVoice
5259
$ helpme uservoice
5360
```
5461

55-
For more details, see our [documentation](https://vsoch.github.io/helpme).
62+
This is a very brief summary of usage. For complete details, see our [documentation](https://vsoch.github.io/helpme).
5663

5764
## Contributing
5865

5966
If you'd like to contribute, we welcome pull requests, feature requests, and any form of help you
6067
might offer! Please see our [contributing guidelines](.github/CONTRIBUTING.md) for more details. Do you
61-
have a question, or did you find a bug? You can [submit an issue](https://www.github.com/vsoch/helpme/issues)
62-
and we will help you out.
68+
have a question, or did you find a bug? You can [submit an issue](https://www.github.com/vsoch/helpme/issues) and we will help you out.
6369

6470
## License
6571

0 commit comments

Comments
 (0)