Browse Source

Revised README.md

Updated name
Changed formatting
Added reference to license
Changed license file name.
master
Brandon Nolet 1 year ago
parent
commit
e230effef1
2 changed files with 28 additions and 15 deletions
  1. 0
    1
      LICENSE.md
  2. 28
    14
      README.md

COPYING → LICENSE.md View File

@@ -672,4 +672,3 @@ may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.


+ 28
- 14
README.md View File

@@ -1,29 +1,43 @@
# nmcli-basic.sh

`nmcli-basic` is a script designed to make setting an interface's addressing parameters interactive and simple to do.
# `nin.sh`
`nin.sh` is a script designed to make setting an interface's addressing parameters interactive and simple to do.

## Installation
## Prerequisites

### Requirements
* Linux
* nmcli
* `bash`
* Linux platform
* `nmcli`

## Installing
Download nmcli-basic.sh and give it execution permissions by running `chmod +x nmcli-basic.sh`

###### or

Copy and paste this into your own text editor and save it with a .sh extension, then give it execution permissions.

## Usage
## Deployment

Add additional notes about how to deploy this on a live system

```bash
./nmcli-basic.sh [usage|static|dhcp]
```
## Built With

* [Bash](https://www.gnu.org/software/bash/)
* [Atom](https://atom.io/)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.
Please make sure to test as appropriate.

## Authors

* **Brandon Nolet** - [Brandonnolet (Gitlab)](https://gitlab.com/brandonnolet)

See also the list of [contributors](https://gitlab.com/Brandonnolet/nmcli-basic/graphs/master) who participated in this project.

## License
[GPLv3](http://www.gnu.org/licenses/)

This project is licensed under the GPLv3 copyleft license. That means that this code and any derivative works are perpetually free - see the [LICENSE.md](LICENSE.md) file for details

## Why Should I Use This?

With basic static/DHCP IPv4 addressing, it's much faster than actually typing out the nmcli commands, especially when you have multiple interfaces to address.

Loading…
Cancel
Save