Skip to content

Commit

Permalink
updated documentation website
Browse files Browse the repository at this point in the history
  • Loading branch information
thevpc committed Sep 12, 2020
1 parent 1da8a2e commit 361761e
Show file tree
Hide file tree
Showing 174 changed files with 3,473 additions and 10,451 deletions.
40 changes: 13 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# nuts
Network Updatable Things Services
<pre>
__ __
/\ \ \ _ __/ /______
/ \/ / / / / __/ ___/
/ /\ / /_/ / /_(__ )
\_\ \/\__,_/\__/____/ version 0.7.0.0
__ __
/\ \ \ _ __/ /______
/ \/ / / / / __/ ___/
/ /\ / /_/ / /_(__ )
\_\ \/\__,_/\__/____/ version 0.7.1.0
</pre>

**nuts** is a Package manager for Java (and other things). It stands for **Network Updatable Things Services** tool. Think of it as **npm** for javascript or **pip** for python. But it lots more... It is a simple tool for managing remote artifacts, installing these artifacts to the current machine and executing such artifacts on need. Each managed artifact is also called a **nuts** which is a **Network Updatable Thing Service** . Nuts artifacts are stored into repositories. A **repository** may be local for storing local Nuts or remote for accessing remote artifacts (good examples are remote maven repositories).
Expand All @@ -25,20 +25,16 @@ What makes **nuts** very helpful is that it simplifies application deployments b
+ search : search for existing/installable artifacts
+ welcome : a command that does nothing but bootstrapping nuts and showing a welcome message.


Visit [nuts website](http:https://core-techs-solutions.com/nuts)


## Download Latest stable version
+ Linux,Windows,iOS, and Java enabled OS : [nuts-0.7.0.jar](https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/0.7.0/nuts-0.7.0.jar)
+ Linux,Windows,iOS, and Java enabled OS : [nuts-0.7.1.jar](https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/0.7.1/nuts-0.7.1.jar)
+ On Unix/Linux platforms you may use :
+ using **wget**
```
wget https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/0.7.0/nuts-0.7.0.jar
wget https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/0.7.1/nuts-0.7.1.jar
```
+ or **curl**
```
curl https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/0.7.0/nuts-0.7.0.jar > nuts-0.7.0.jar
curl https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/0.7.1/nuts-0.7.1.jar > nuts-0.7.1.jar
```
Note that you will need a valid Java Runtime Environment (JRE) or Java Development Kit (JDK) version **8** or later to run **nuts**.

Expand All @@ -48,7 +44,7 @@ It will create all needed configuration files upon the very first launch.
More details are available at [wiki installation page](https://github.com/thevpc/nuts/wiki/Installation)

```
java -jar nuts-0.7.0.jar
java -jar nuts-0.7.1.jar
```
Yous should then see some log like the following :

Expand All @@ -71,16 +67,16 @@ All tests where performed on OpenSuse Tumbleweed.

## Windows Systems
On Windows systems, first launch will create a new Nuts Menu (under Programs) and a couple of Desktop shortcuts to launch a configured command terminal.
+ **nuts-cmd-0.7.0** : this shortcut will open a configured command terminal. **nuts** command will be available as well
+ **nuts-cmd-0.7.1** : this shortcut will open a configured command terminal. **nuts** command will be available as well
as several nuts companion tools installed by **ndi** by default
+ **nuts-cmd** : this shortcut will point to the last installed **nuts** version, here 0.7.0
+ **nuts-cmd** : this shortcut will point to the last installed **nuts** version, here 0.7.1

Any of these shortcuts will launch a nuts-aware terminal.

Supported Windows systems include Window 7 and later.

## MacOS Systems
Installation will worl seemlely on MacOS as far as you are using bash shell. All Linux installatio notes apply then.
Installation will work seamlessly on MacOS as far as you are using bash shell. All Linux installation notes apply then.

## Test Installation
To test installation the simplest way is to open a nuts-aware terminal and type :
Expand All @@ -92,7 +88,7 @@ nuts --version
It should show a result in the format : nuts-api-version/nuts-impl-version

```
00.7.0/0.7.0.0
00.7.1/0.7.1.0
```

## Run a command
Expand Down Expand Up @@ -120,13 +116,3 @@ Nuts have lots of ways to be improved. Please feel free to join the journey.
View stable releases in [official releases page](https://github.com/thevpc/nuts/releases).

View all releases in [release details page](docs/change-log/release-details.md).

## Read more

- [Introduction, Why and What for](docs/articles/01-nuts-introduction.md)
- [Project and Repository Organization](docs/articles/02-nuts-projects.md)
- [Nuts Text Coloring Format](docs/articles/04-nuts-text-coloring-format.md)
- [File System](docs/articles/03-nuts-filesystem.md)
- [Commandline Format](docs/articles/05-nuts-commandline.md)
- [FAQ](docs/articles/10-nuts-faq.md)
- [Troubleshooting](docs/troubleshooting.md)
2 changes: 1 addition & 1 deletion README.md.pre
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Any of these shortcuts will launch a nuts-aware terminal.
Supported Windows systems include Window 7 and later.

## MacOS Systems
Installation will worl seemlely on MacOS as far as you are using bash shell. All Linux installatio notes apply then.
Installation will work seamlessly on MacOS as far as you are using bash shell. All Linux installation notes apply then.

## Test Installation
To test installation the simplest way is to open a nuts-aware terminal and type :
Expand Down
1 change: 1 addition & 0 deletions _pre-deploy.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nuts worky process-file *.pre
4 changes: 2 additions & 2 deletions app-include.pre-script
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
apiVersion='0.7.0';
implVersion='0.7.0.0';
apiVersion='0.7.1';
implVersion='0.7.1.0';
jarLocation=processString("https://github.com/thevpc/vpc-public-maven/raw/master/net/vpc/app/nuts/nuts/${apiVersion}/nuts-${apiVersion}.jar");
File renamed without changes.
1 change: 1 addition & 0 deletions docs/01a85c17.b59f7186.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/091f20d6.63b57531.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 361761e

Please sign in to comment.