Skip to content

Commit b7d868f

Browse files
committed
Small change to README
1 parent 477823c commit b7d868f

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

README.md

+9-11
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,14 @@ This project contains an implementation of [Shape Expressions (ShEx)](http://www
1111

1212
## Introduction
1313

14-
This project contains a Scala implementation of [ShEx](http://shex.io/).
15-
The library handles RDF using a
14+
This project contains a Scala implementation of [ShEx](http://shex.io/).
15+
The library handles RDF using a
1616
[simple RDF library](https://github.com/weso/srdf), which at this moment has 2 implementations,
1717
one using [Apache Jena](https://jena.apache.org/)
1818
and another one using [RDF4j](http://rdf4j.org/).
1919
This means that it is possible to use this library to validate RDF models from either Jena or RDF4J models,
2020
as well as from external SPARQL endpoints.
2121

22-
2322
## Installation and compilation
2423

2524
The project uses [sbt](http://www.scala-sbt.org/) for compilation as well as Java 1.8.
@@ -28,15 +27,15 @@ The project uses [sbt](http://www.scala-sbt.org/) for compilation as well as Jav
2827

2928
## Command line usage
3029

31-
It is possible to run `shex-s` as a command line tool.
30+
It is possible to run `shex-s` as a command line tool.
3231

33-
To create the executable you have to install [scala-cli](https://scala-cli.virtuslab.org/) and once it is installed run the following command in the folder with the shexs repository:
32+
To create the executable you can use the following command:
3433

3534
```
36-
$ scala-cli package . -o shexs -f
35+
sbt universal:packageBin
3736
```
3837

39-
which will create an executable called `shexs`
38+
and it will generate a zip file in the folder: `target/universal` which contains an executable called `shexs`
4039

4140
```
4241
Usage:
@@ -70,7 +69,7 @@ Subcommands:
7069
Schema processing actions
7170
```
7271

73-
It is possible to create binaries for different platforms like Linux, Windows, MacOS, etc.
72+
It is possible to create binaries for different platforms like Linux, Windows, MacOS, etc.
7473
We would like to publish those binaries with each release as discribed [in this issue](https://github.com/weso/shex-s/issues/344).
7574

7675
### Validate option
@@ -148,16 +147,16 @@ sbt:shex> test
148147

149148
## Generating docs page
150149

151-
152-
153150
## Publishing to OSS-Sonatype
154151

155152
This project uses [the sbt ci release](https://github.com/olafurpg/sbt-ci-release) plugin for publishing to [OSS Sonatype](https://oss.sonatype.org/).
156153

157154
##### SNAPSHOT Releases
155+
158156
Open a PR and merge it to watch the CI release a -SNAPSHOT version
159157

160158
##### Full Library Releases
159+
161160
1. Push a tag and watch the CI do a regular release
162161
2. `git tag -a v0.1.0 -m "v0.1.0"`
163162
3. `git push origin v0.1.0`
@@ -192,7 +191,6 @@ Contributions are greatly appreciated.
192191
Please fork this repository and open a
193192
pull request to add more features or [submit issues](https://github.com/labra/shaclex/issues)
194193

195-
196194
<a href="https://github.com/weso/shex-s/graphs/contributors">
197195
<img src="https://contributors-img.web.app/image?repo=weso/shex-s" />
198196
</a>

0 commit comments

Comments
 (0)