Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme #145

Merged
merged 12 commits into from
Jan 22, 2022
46 changes: 28 additions & 18 deletions .dir-template/src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,25 @@ Network Updatable Things Services
\_\ \/\__,_/\__/____/ production version ${{stableImplVersion}} (accessible on maven central)
</pre>

website : [https://thevpc.github.io/nuts](https://thevpc.github.io/nuts)
Website : [https://thevpc.github.io/nuts](https://thevpc.github.io/nuts)

```nuts``` is a Java™ Package Manager that helps discovering, downloading, assembling and executing local and remote artifacts (packages) in a very handy way.
```nuts``` is a Java™ Package Manager that helps discover, download, assemble and execute local and remote artifacts (packages) in an easy and straightforward way.

Unlike maven which resolves dependencies at compile time, ```nuts``` solves dependencies and builds the classpath at install time and, as a result, saves disk and bandwidth by downloading and caching only libraries required for the current environment and share them between multiple installed applications.
Unlike Maven which resolves dependencies at compile time, ```nuts``` solves dependencies and builds the classpath at install time and, as a result, saves disk storage and bandwidth by downloading and caching only libraries required for the current environment and share them between multiple installed applications.

```nuts``` is unique in that it reuses maven and other build tool descriptor formats to solve dependency graph, and does not, whatsoever, have any requirement on existing maven created packages.
```nuts``` is unique in that it reuses Maven and other build tool descriptor formats to solve dependency graphs, and does not, whatsoever, have any requirement on existing Maven created packages.

```nuts``` is the ultimate solution to get rid of the ugly lib jars, fat-jars, uber-jars and one-jars used for deploying java applications.

## SYNOPSYS
## SYNOPSIS

This is just enough info to get you up and running ```nuts``` .
Much more info is available in [nuts documentation website](https://thevpc.github.io/nuts).
You can have some information also browsing [thevpc.net](https://thevpc.net/nuts/)
Much more info is available on [nuts documentation website](https://thevpc.github.io/nuts).
You can also have more information also browsing [thevpc.net](https://thevpc.net/nuts/).
Even more information is available via ```nuts help``` once it's installed.

To check current nuts version

```
nuts --version
```
Expand All @@ -38,24 +39,29 @@ ${{apiVersion}}/${{implVersion}}

## Installing Nuts Preview (Development, recommended for testing)

If you want to install (or update from existing rolling version) you just need to do the following.
Please that nuts rolling version (which is the most recent version) is quite stable and you can use it for personal usage, for development or for testing but we recommend you consider official versions for production systems.
If you want to install ```nuts``` (or update from an existing rolling version) you just need to do the following. <br />
<br />
Please note that ```nuts``` rolling version (which is the most recent version) is quite stable and you can use it for personal usage, for development or for testing but we recommend you consider official versions for production systems.

First you need to download nuts-preview.jar

```
wget https://thevpc.net/nuts-preview.jar -O nuts.jar
```

Then you must run, in a terminal, the following command.
Then you must run, in a terminal, the following command

```
java -jar nuts.jar -Zy -r=+dev
```

That’s it, now you must relaunch the terminal window (close the terminal and start it again).

The following command should show you the actual version
The following command should show you the current version

```
nuts --version
```


## Installing Nuts (Stable, recommended for Production)
Expand All @@ -69,32 +75,36 @@ wget wget https://repo1.maven.org/maven2/net/thevpc/nuts/nuts/${{stableApiVersio
```

If you want a shorter link, use this one!

```
wget https://thevpc.net/nuts-stable.jar -O nuts.jar
```


Then you must run, in a terminal, one of the the following commands.
Then you must run, in a terminal, one of the the following commands:

Run this command to reset the configuration or when you are installing the very first time

```
java -jar nuts.jar -Zy
```

Or run this command when you want to reinstall nuts from scratch without resetting the configuration

```
java -jar nuts.jar -Ny
```

That’s it, now you must relaunch the terminal window (close the terminal and start it again).

The following command should show you the actual version
The following command should show you the current version

```
nuts version
nuts --version
```

## Updating from previously installed version
## Updating from a previously installed version

Run the following command to update to the latest version

```
nuts update
Expand All @@ -115,7 +125,7 @@ To run an artifact using **nuts** just type
nuts <package>
```

Several commands are available, and you can always manually run any java and non java application. More info is available in the Nuts official website : [https://thevpc.github.io/nuts](https://thevpc.github.io/nuts).
Several commands are available, and you can always manually run any java and non java application. More info is available on the Nuts official website: [https://thevpc.github.io/nuts](https://thevpc.github.io/nuts).

## Call for Contribution
Nuts have lots of ways to be improved. Please feel free to join the journey.
```nuts``` has lots of ways to be improved. Please feel free to join the journey.