[incubator-annotator] branch feature/150-Include-info-on-how-to-build-in-the-README created (now c3eac49)

[re...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rec pushed a change to branch feature/150-Include-info-on-how-to-build-in-the-README
in repository https://gitbox.apache.org/repos/asf/incubator-annotator.git


      at c3eac49  Issue #150 - Include info on how to build in the README

This branch includes the following new commits:

     new c3eac49  Issue #150 - Include info on how to build in the README

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.

[incubator-annotator] 01/01: Issue #150 - Include info on how to build in the README

[re...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

rec pushed a commit to branch feature/150-Include-info-on-how-to-build-in-the-README
in repository https://gitbox.apache.org/repos/asf/incubator-annotator.git

commit c3eac49bd52debdaca02e356233cfcb39b574df3
Author: Richard Eckart de Castilho <re...@apache.org>
AuthorDate: Tue Oct 3 13:25:18 2023 +0200

    Issue #150 - Include info on how to build in the README
    
    - Include info on building and testing into the README file
    - Remove deprecated webpack dev-server option preventing the dev-server from starting
---
 README.md             | 9 +++++++++
 web/webpack.config.js | 3 ---
 2 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 8816d18..02f75de 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,15 @@ browser environments.
 
 See documentation on the website: <https://annotator.apache.org/docs/>
 
+## How to build
+
+Build requirements are [Node.JS](https://nodejs.org/) (>= 16) and [yarn](https://yarnpkg.com) (1.x). All
+other dependencies are automatically installed as part of the build.
+
+* `npm run build` -- builds the project
+* `npm test` -- runs the tests
+* `npm run start` -- starts the demo application
+
 ## Getting Involved
 
 * Join the [mailing list](http://mail-archives.apache.org/mod_mbox/incubator-annotator-dev/). Send an email to
diff --git a/web/webpack.config.js b/web/webpack.config.js
index 16ef2ef..198ea87 100644
--- a/web/webpack.config.js
+++ b/web/webpack.config.js
@@ -50,7 +50,4 @@ module.exports = {
     // Note this directory is imported by the annotator website
     path: path.resolve(__dirname, 'dist'),
   },
-  devServer: {
-    contentBase: false,
-  },
 };