Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
Samuel FORESTIER committed Dec 10, 2017
2 parents c5df236 + 87538e9 commit 55a65ef
Show file tree
Hide file tree
Showing 3 changed files with 193 additions and 55 deletions.
71 changes: 54 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,59 @@
# archey4
# Archey 4

![archey4](https://horlogeskynet.github.io/img/blog/the-archey-project-what-i-ve-decided-to-do.png?v410)
![archey4](https://horlogeskynet.github.io/img/blog/the-archey-project-what-i-ve-decided-to-do.png?v4.3.0)

#### Why (again) a f*cking new Archey fork ?
## Why (again) a f*cking new Archey fork ?

The answer is [here](https://horlogeskynet.github.io/archey4).

> Note : Since the 21st September of 2017, you may notice that this repository no longer has the official status of _fork_.
> Note : Since the 21st September of 2017, you may notice that this repository no longer has the official status of fork.
> Actually, the maintainer decided to separate it from the original one's "network" with the help of the _GitHub_'s staff.
> Nevertheless, **this piece of software is still a _fork_ of the [djmelik's Archey project](https://github.com/djmelik/archey.git)**.
> Nevertheless, **this piece of software is still a fork of the [djmelik's Archey project](https://github.com/djmelik/archey.git)**.
#### Which packages do I need to run this script ?
## Which packages do I need to run this script ?

##### Required packages
### Required packages

* python3
* lsb-release
* procps

##### Highly recommended packages
### Highly recommended packages

| Environments | Packages | Reasons | Notes |
| :----------- | :--------: | :-----------------------------------: | :---: |
| All | `dnsutils` | _WAN\_IP_ will be detected 5x faster | |
| Graphical | `wmctrl` | _WindowManager_ will be more accurate | |
| Virtual | `virt-what`<br />`dmidecode` | _Model_ will contain details about the hypervisor | `archey` will need to be run as **root** |
| All | `dnsutils`<br>`net-tools` | **WAN_IP** and **LAN_IP** would be detected faster | They will provide `dig` and `hostname` |
| Graphical | `pciutils`<br>`wmctrl` | **GPU** wouldn't be detected without it<br>**WindowManager** would be more accurate | `pciutils` will provide `lspci` |
| Virtual | `virt-what`<br>`dmidecode` | **Model** would contain details about the hypervisor | `archey` will need to be run as **root** |

## Installation

### Install latest stable release from source
### Install from package

First, grab a package for your distribution from the latest release [here](https://github.com/HorlogeSkynet/archey4/releases/latest).
Now, it's time to use your favorite packages manager. Some examples :

* Arch-based distributions ([source](https://aur.archlinux.org/packages/archey4/))

```shell
pacman -U ./archey4-v4.X.Z-R-any.pkg.tar.xz
```

* Debian-based distributions ([source](https://labs.pixelswap.fr/HorlogeSkynet/archey4-packaging))

```shell
apt install ./archey4-4.Y.Z-R-all.deb
```

* Red Hat, Fedora, OpenSuse, ... ([source](https://labs.pixelswap.fr/HorlogeSkynet/archey4-packaging))

```shell
dnf install ./archey4-4.Y.Z-R.noarch.rpm
```

### Install from source

#### Latest stable release

```shell
$ wget -O archey4.tar.gz https://github.com/HorlogeSkynet/archey4/archive/master.tar.gz
Expand All @@ -37,7 +63,7 @@ $ chmod +x archey
$ sudo cp archey /usr/local/bin/archey
```

### Install (or update) development version from source
#### Development version

```shell
$ git clone https://github.com/HorlogeSkynet/archey4.git
Expand All @@ -54,12 +80,23 @@ $ sudo cp archey /usr/local/bin/archey
$ archey
```

#### Notes to users
## Configuration (optional)

Since the version 1.4.0, Archey 4 **may** be "tweaked" a bit with external configuration.
You can place a [`config.json`](config.json) file in these locations :

1. `./config.json` (beside the script itself)
2. `~/.config/archey4/config.json` (in your home directory)
3. `/etc/archey4/config.json`

If an option is defined in multiple places, it will be overridden according to the order above (local preferences > user preferences > system preferences).

## Notes to users

* If you run `archey` as root, the script will list the processes running by other users on your system in order to display correctly _Window Manager_ & _Desktop Environment_ outputs.
* If you run `archey` as root, the script will list the processes running by other users on your system in order to display correctly **Window Manager** & **Desktop Environment** outputs.

* During the setup procedure, I advised you to copy this script into the `/usr/local/bin/` folder, you may want to check what it does beforehand.

* If you experience any trouble during installation or usage, please do [**open an _issue_**](https://github.com/HorlogeSkynet/archey4/issues/new).
* If you experience any trouble during installation or usage, please do **[open an issue](https://github.com/HorlogeSkynet/archey4/issues/new)**.

* If you had to adapt the script to make it working with your system, please [**open a _pull request_**](https://github.com/HorlogeSkynet/archey4/pulls) so as to share your modifications with the rest of the world and participate to this project !
* If you had to adapt the script to make it working with your system, please **[open a pull request](https://github.com/HorlogeSkynet/archey4/pulls)** so as to share your modifications with the rest of the world and participate in this project !
Loading

0 comments on commit 55a65ef

Please sign in to comment.