Skip to content

Commit

Permalink
Refine grobid-service/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
koppor committed Mar 8, 2020
1 parent d023bf8 commit 02240d3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
3 changes: 3 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ indent_size=2
indent_style=space
indent_size=2

[*.md]
insert_final_newline=true

[{*.yml,*.yaml}]
indent_style=space
indent_size=2
Expand Down
15 changes: 7 additions & 8 deletions grobid-service/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
## Running service
# Grobid Service

## Running service

* From IntelliJ IDEA:
* Just run the `main()` in `org.grobid.service.main.GrobidServiceApplication`
* Just run the `main()` in `org.grobid.service.main.GrobidServiceApplication`
* Via Gradle, under the project main repository `grobid/`:
* `./gradlew grobid-service:run`
* `./gradlew grobid-service:run`

## Building a distribution

* under the project main repository `grobid/`:
* `./gradlew grobid-service:assemble`
* Under the project main repository `grobid/`:
* `./gradlew grobid-service:assemble`
* The distribution can be found in `grobid/grobid-service/build/distributions/`. An archive contains
* All runtime dependencies
* A bash script to start a server (`bin/grobid-service service "$path-to-yaml-config"`)
Expand All @@ -23,6 +25,3 @@ Things to change:
* Make sure to provide a path to a valid a grobid-home
* Ports might be adapted in `server.applicationConnectors.port` (default is `:8070`)
* Adapt the logging folders as needed, or remove file appender if you don't need file logging.



0 comments on commit 02240d3

Please sign in to comment.