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
Next Next commit
Update README.md
  • Loading branch information
SelimSkhiri committed Jan 22, 2022
commit fc23f95a92176af4b5fe327ae09dc79fcf7d7f10
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,19 @@ Network Updatable Things Services

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 a very handy way.
[//]: # a comment

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 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 graph, 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).
Much more info is available in [nuts documentation website](https://thevpc.github.io/nuts/docs).
You can have some information also browsing [thevpc.net](https://thevpc.net/nuts/)
Even more information is available via ```nuts help``` once it's installed.

Expand All @@ -39,15 +40,15 @@ It should show a result in the format : nuts-api-version/nuts-runtime-version
## 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.
Please that nuts rolling version (which is the most recent version) is quite stable and you can use it for personal use, 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
Expand Down Expand Up @@ -115,7 +116,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.