Skip to content
Snippets Groups Projects
Commit 87ec484c authored by Keegan Mullaney's avatar Keegan Mullaney
Browse files

simplify readme

parent 1bbb9ef0
No related branches found
No related tags found
No related merge requests found
Loading
Loading
@@ -18,7 +18,7 @@ Quickly configures a fresh install of [Ubuntu 16.04 64-bit][xx] on a workstation
 
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
## What it can do
## What qc can do
 
- update [Ubuntu][ubuntu] and install some programs using apt-get, gem, npm and pip
- generate an [RSA key][sshkey] for remote [SSH sessions][ssh]
Loading
Loading
@@ -37,37 +37,20 @@ Quickly configures a fresh install of [Ubuntu 16.04 64-bit][xx] on a workstation
- install the latest [VirtualBox][vb] and [Vagrant][vg]
- install [LXD][lxd], use it to download an [Ubuntu][xx] cloud image and create an [LXC][lxc] container
- install [ZFS][zfs] for use with [LXD][lxd]
- install [Juju][juju] and use it to configure the [WordPress][wp] Juju [Charm][charms]
- install [Juju][juju]
 
## Usage
### Clone or download this project
- HTTPS: `git clone https://github.com/keegoid/quick-config.git`
- SSH: `git clone git@github.com:keegoid/quick-config.git`
### Run it
Run the main program with `./run.sh`
## Installation
 
If it doesn't work, you might need to do this:
Clone or download this repo.
 
```bash
chmod +x run.sh
dos2unix -k run.sh
git clone https://github.com/keegoid/qc.git
```
 
Also run `./sudoers.sh` if you want to increase the sudo timeout which is set to 15 minutes by default.
## SSH Keys
You can save a backup copy of your [SSH key pair][sshkey] that gets generated and output to the screen. I prefer saving it as a secure note in [LastPass][lp]. Copy the keys from the [terminal][gt] with `ctrl+shift+c` before clearing the screen.
## Usage
 
```bash
cat ~/.ssh/id_rsa.pub
cat ~/.ssh/id_rsa
clear
```
Run the main program with `./qc.sh`
Optionally run `./sudoers.sh` if you want to increase the sudo timeout which is set to 15 minutes by default.
 
## License
 
Loading
Loading
@@ -80,7 +63,6 @@ SEE: http://keegoid.mit-license.org
[lxc]: https://linuxcontainers.org/lxc/introduction/
[zfs]: https://wiki.ubuntu.com/ZFS
[juju]: http://www.ubuntu.com/cloud/juju
[charms]: https://jujucharms.com/
[gedit]: https://wiki.gnome.org/Apps/Gedit
[subl]: https://www.sublimetext.com/
[vim]: http://www.vim.org/
Loading
Loading
@@ -95,7 +77,6 @@ SEE: http://keegoid.mit-license.org
[vb]: https://www.virtualbox.org/
[vg]: https://www.vagrantup.com/
[aj]: https://github.com/wting/autojump
[wp]: https://wordpress.org/
[ssh]: http://en.wikipedia.org/wiki/Secure_Shell
[sshkey]: http://en.wikipedia.org/wiki/Ssh-keygen
[sa]: http://en.wikipedia.org/wiki/Alias_%28command%29
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment