Skip to content

Commit ee91b32

Browse files
committed
Added README and Contribution Guide
1 parent d28d3c1 commit ee91b32

File tree

3 files changed

+91
-1
lines changed

3 files changed

+91
-1
lines changed

CONTRIBUTING.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contribution Guide
2+
3+
We follow the GitHub [Fork & Pull][forkandpull] and [Git Flow][gitflow] workflow in this project.
4+
Please fork the official repository, develop in a branch based on the
5+
current develop branch, and submit a pull request (PR) after you are done.
6+
7+
[forkandpull]: https://help.github.com/articles/about-pull-requests/
8+
[gitflow]: http://nvie.com/posts/a-successful-git-branching-model/
9+
10+
## Checklist before submitting a Pull Request
11+
12+
Before you submit your PR, please go through this list and check if
13+
your request fulfills these points.
14+
15+
- Do you have more changes/additions/deletions in your PR than you expected?
16+
- Do you have tests for your changes?
17+
- Do all tests of the project succeed?
18+
- Is your pull request based on the `develop` branch? [(cf. GitFlow)][gitflow]
19+
20+
If you check these items before, your pull request is more likely to be
21+
included into the project quickly.
22+

README.md

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# Delphi Command-Line Interface (CLI)
2+
3+
The command-line interface for the Delphi platform.
4+
5+
We are currently in pre-alpha state! There is no release and the code in
6+
this repository is purely experimental!
7+
8+
|branch | status | codacy |
9+
| :---: | :---: | :---: |
10+
| master | <img src="https://travis-ci.org/delphi-hub/delphi-cli.svg?branch=master"> | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/9f94d02785594f35be1c6d0d9acba9e9)](https://www.codacy.com/app/bhermann/delphi-cli?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=delphi-hub/delphi-cli&amp;utm_campaign=Badge_Grade)|
11+
| develop | <img src="https://travis-ci.org/delphi-hub/delphi-cli.svg?branch=develop"> | |
12+
13+
## What is the Delphi Command-Line Interface?
14+
15+
The Delphi CLI is a tool to access the data on the Delphi platform.
16+
It enables you to search for items matching a query or to inspect a dataset for an item in detail.
17+
It can be used in an automated context to automatically construct fitting item sets.
18+
19+
## How does it work?
20+
21+
The Delphi CLI checks the provided query and passes it on to the web API of the configured platform.
22+
The results are printed to the console by default.
23+
24+
## How can I use it?
25+
26+
The Delphi CLI is running on the Java Virtual Machine.
27+
We require a Java Runtime Environment (JRE) in version 8 or newer.
28+
29+
Our software is available as a binary release on [GitHub](https://github.com/delphi-hub/delphi-cli/releases).
30+
31+
```
32+
$ delphi-cli --help
33+
Delphi Command Line Tool (1.0.0-SNAPSHOT)
34+
Usage: delphi-cli [test|search|retrieve] [options]
35+
36+
--version Prints the version of the command line tool.
37+
--help Prints this help text.
38+
--server <value> The url to the Delphi server
39+
```
40+
By default the command-line tool uses the official Delphi server at https://delphi.cs.uni-paderborn.de to process queries.
41+
You can override this setting using the `--server` option or by setting the `DELPHI_SERVER` environment variable.
42+
43+
## Community
44+
45+
Feel welcome to join our chatroom on Gitter: [![Join the chat at https://gitter.im/delphi-hub/delphi](https://badges.gitter.im/delphi-hub/delphi.svg)](https://gitter.im/delphi-hub/delphi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
46+
47+
48+
## Contributing
49+
50+
Contributions are *very* welcome!
51+
52+
Before contributing, please read our [Code of Conduct](CODE_OF_CONDUCT.md).
53+
54+
Refer to the [Contribution Guide](CONTRIBUTING.md) for details about the workflow.
55+
We use Pull Requests to collect contributions. Especially look out for "help wanted" issues
56+
[![GitHub issues by-label](https://img.shields.io/github/issues/delphi-hub/delphi-cli/help%20wanted.svg)](https://github.com/delphi-hub/delphi-cli/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22),
57+
but feel free to work on other issues as well.
58+
You can ask for clarification in the issues directly, or use our Gitter
59+
chat for a more interactive experience.
60+
61+
[![GitHub issues](https://img.shields.io/github/issues/delphi-hub/delphi-cli.svg)](https://github.com/delphi-hub/delphi-cli/issues)
62+
63+
64+
## License
65+
66+
The Delphi CLI is open source and available under Apache 2 License.
67+
68+
[![GitHub license](https://img.shields.io/github/license/delphi-hub/delphi-cli.svg)](https://github.com/delphi-hub/delphi-cli/blob/master/LICENSE)

src/main/scala/de/upb/cs/swt/delphi/cli/Config.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ package de.upb.cs.swt.delphi.cli
66
* @param verbose Marker if logging should be verbose
77
* @param mode The command to be run
88
*/
9-
case class Config (server : String = sys.env.getOrElse("DELPHI_SERVER", ""), verbose: Boolean = false, mode : String = "") {
9+
case class Config (server : String = sys.env.getOrElse("DELPHI_SERVER", "https://delphi.cs.uni-paderborn.de/api/"), verbose: Boolean = false, mode : String = "") {
1010

1111
}

0 commit comments

Comments
 (0)