Commit d4aede2a authored by Laurent Wouters's avatar Laurent Wouters
Browse files

[doc] Updated the readme

parent 51ec277352f2
...@@ -6,14 +6,13 @@ The toolkit for the production of a browser of the web of data. ...@@ -6,14 +6,13 @@ The toolkit for the production of a browser of the web of data.
This repository contains multiple packages. It is structured as follow: This repository contains multiple packages. It is structured as follow:
- `librdf` contains the sources for the NPM package `@logilab/librdf`.
This package defines some utility API for the manipulation of RDF datasets.
- `libview` contains the sources for the NPM package `@logilab/libview`. - `libview` contains the sources for the NPM package `@logilab/libview`.
This package defines the common interface that has to be implemented by views for the web of data browser. This package defines the common interface that has to be implemented by views for the web of data browser.
- `extension` contains the sources for the Chrome and Firefox web extension (`@logilab/ld-browser`) that really implements the browser for the web of data. - `extension` contains the sources for the Chrome and Firefox web extension (`@logilab/ld-browser`) that really implements the browser for the web of data.
To use the browser, this extension has to be deployed in a regular web browser. To use the browser, this extension has to be deployed in a regular web browser.
- `views-*` contain the sources for specialized views that can be leveraged by the web of data browser. - `views-*` contain the sources for specialized views that can be leveraged by the web of data browser.
They mostly take the form of NPM projects. They mostly take the form of NPM projects.
- `views-logilab` contains the sources for the Person and Book views.
## General concepts ## General concepts
...@@ -43,12 +42,6 @@ npm run serve ...@@ -43,12 +42,6 @@ npm run serve
``` ```
This will launch a development web server that serves the views so that the it can be referred to by the browser. This will launch a development web server that serves the views so that the it can be referred to by the browser.
For example, for serving the `dbpedia`-specific views:
```sh
cd views-dbpedia
npm run serve
```
The descriptors for the views can then be accessed at [http://localhost:8080/index.vd.json](http://localhost:8080/index.vd.json). The descriptors for the views can then be accessed at [http://localhost:8080/index.vd.json](http://localhost:8080/index.vd.json).
This is the URI that can be defined as a source of views for the browser. This is the URI that can be defined as a source of views for the browser.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment