Skip to content

Commit

Permalink
Replace automated script with manual install steps to fix data loss
Browse files Browse the repository at this point in the history
@TolichP [1] reported in #3 [2
`install.sh` script replaced the `config` file which led to
configuration/data loss. This was caused by the `-f` flag passed to the
`cp` command [3] which forced to override existing files.

This is a really critical bug and the the solution to provide a script
that automatically handles the simple task of copying a file has never
been a good idea at all. Therefore the script was removed and the
documentation has been adjusted to provide manual installation steps
instead like in other port projects, e.g. Nord Alacritty [4].
The manual steps are quite simple and the knowledge can be expected of
users since these are basic operations when running a Unix system.

Projects like Terminato, that require to modify the main user
configuration file instead of providing a way to load features like
themes from dedicated file, are always way harder to support as a
theme author. Anyway, there are plans to unify the installation of Nord
port projects through one universal automation tool,
but there is currently no ETA.

[1]: https://github.com/TolichP
[2]: #3 (comment)
[3]: https://github.com/arcticicestudio/nord-terminator/blob/af29e150a531f7984d362f4aa135c1bfffd13c45/install.sh#L83
[4]: https://github.com/arcticicestudio/nord-alacritty

GH-12
  • Loading branch information
arcticicestudio committed Apr 8, 2020
1 parent e96cfe0 commit 5ea80a4
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 143 deletions.
49 changes: 29 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,38 +11,47 @@ Based on the <a href="https://github.com/arcticicestudio/nord">Nord</a> color pa

<p align="center"><img src="https://raw.githubusercontent.com/arcticicestudio/nord-terminator/develop/src/assets/scrot-colortest.png"/><blockquote>Font: <a href="https://adobe-fonts.github.io/source-code-pro">Source Code Pro</a> 12px.</blockquote></p>

## Getting started
### Installation
#### Manual
Copy the [`config`](https://github.com/arcticicestudio/nord-terminator/blob/develop/src/config) file to the local configuration directory `~/.config/terminator`.

#### Install Script
The included `install.sh` shell script can be used for an automated installation.
If no option is specified, the default color config file is `src/config`.

A list of available options can be shown with the `--help` option.
```shell
./install.sh --help
```
Syntax: `install.sh [OPTIONS]`

| Option | Description |
| --- | --- |
| `-h`, `--help` | Shows the help |
| `-v`, `--verbose` | Verbose output |
| `-c <COLOR_CONFIG_FILE>`, `--configfile <COLOR_CONFIG_FILE>` | Use the specified color config file |
## Installation

To install _Nord_, the content of the [`config`][src-config] file must be manually transferred to [your configuration file][archw-terminator#config] that is usually located at `~/.config/terminator/config`.

1. Replace or add the configuration keys for the `global_config` section:
```diff
[global_config]
+ title_inactive_bg_color = "#4C566A"
+ title_inactive_fg_color = "#D8DEE9"
+ title_receive_bg_color = "#8FBCBB"
+ title_receive_fg_color = "#2E3440"
+ title_transmit_bg_color = "#88C0D0"
+ title_transmit_fg_color = "#2E3440"
```
2. Append the `[[nord]]` profile of to the `[profiles]` section to create a new profile for _Nord_:
```diff
[profiles]
+ [[nord]]
+ background_color = "#2E3440"
+ cursor_color = "#D8DEE9"
+ foreground_color = "#D8DEE9"
+ palette = "#3B4252:#BF616A:#A3BE8C:#EBCB8B:#81A1C1:#B48EAD:#88C0D0:#E5E9F0:#4C566A:#BF616A:#A3BE8C:#EBCB8B:#81A1C1:#B48EAD:#8F BCBB:#ECEFF4"
```

## Screenshots

<p align="center"><strong>htop</strong><br><img src="https://raw.githubusercontent.com/arcticicestudio/nord-terminator/develop/src/assets/scrot-htop.png"/></p>

## Development

[![](https://img.shields.io/badge/Changelog-0.1.0-81A1C1.svg?style=flat-square)](https://github.com/arcticicestudio/nord-terminator/blob/v0.1.0/CHANGELOG.md) [![](https://img.shields.io/badge/Workflow-gitflow--branching--model-81A1C1.svg?style=flat-square)](http://nvie.com/posts/a-successful-git-branching-model) [![](https://img.shields.io/badge/Versioning-ArcVer_0.8.0-81A1C1.svg?style=flat-square)](https://github.com/arcticicestudio/arcver)

### Contribution

Please report issues/bugs, feature requests and suggestions for improvements to the [issue tracker](https://github.com/arcticicestudio/nord-terminator/issues).

<p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/src/assets/banner-footer-mountains.svg" /></p>

<p align="center">Copyright &copy; 2016-present Arctic Ice Studio</p>

<p align="center"><a href="https://github.com/arcticicestudio/nord-terminator/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a> <a href="https://creativecommons.org/licenses/by-sa/4.0"><img src="https://img.shields.io/badge/License-CC_BY--SA_4.0-5E81AC.svg?style=flat-square"/></a></p>

[archw-terminator#config]: https://wiki.archlinux.org/index.php/Terminator#Configuration
[src-config]: https://github.com/arcticicestudio/nord-terminator/blob/develop/src/config
123 changes: 0 additions & 123 deletions install.sh

This file was deleted.

0 comments on commit 5ea80a4

Please sign in to comment.