Skip to content

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bjvickers committed Mar 27, 2023
1 parent 98d32ab commit fcf23e4
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,36 @@


## Overview
Provides a WebFX project template. Prevents the need for the WebFX CLI to be installed alongside a WebFX project. Instead, developers can install this archetype, then generate a new WebFX project from it using the commands below. This archetype will (eventually) allow all WebFX functions to be incorporated into the IDE.
Provides a WebFX project template. Prevents the need for the WebFX CLI to be installed alongside a WebFX project. Instead, developers can install this archetype, then generate a new WebFX project from it using the commands below.

This archetype will, in conjuction with the [WebFX-Maven-Plugin](https://github.com/webfx-project/webfx-maven-plugin), allow all WebFX functions to be incorporated into the IDE.


## Usage
### 1. Install the WebFX Maven Archetype to the local Maven repository:


### 1. Download the WebFX Maven Archetype:
```sh
mkdir -vp webfx-maven-archetype
cd webfx-maven-archetype
mkdir -vp ~/webfx-maven-archetype
cd ~/webfx-maven-archetype
git clone https://github.com/webfx-project/webfx-maven-archetype.git .
```


### 2. Install to the local Maven repository:
```sh
mvn install
```

### 2. Now build a new WebFX project from the archetype:

### 3. Create your WebFX project folder:
```sh
mkdir -vp ~/my-webfx-project
cd ~/my-webfx-project
```


### 4. Build a new, empty WebFX project from the archetype:
```sh
mkdir -vp ~/my-new-webfx-project
cd ~/my-new-webfx-project
mvn archetype:generate -DarchetypeGroupId=dev.webfx -DarchetypeArtifactId=webfx-maven-archetype -DarchetypeVersion=1.0-SNAPSHOT
```

0 comments on commit fcf23e4

Please sign in to comment.