From 3897ee8048d24cea313ebbbfd295ce3dc3084a16 Mon Sep 17 00:00:00 2001 From: George Rawlinson Date: Fri, 21 Oct 2016 16:05:56 +1300 Subject: [PATCH] Update README files --- README.md | 33 +++++---------------------------- npm/README.md | 4 ++-- ssh/README.md | 2 +- xfce4/README.md | 3 +++ 4 files changed, 11 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 2121e97..0a6a96d 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,9 @@ -# Repository for dotfiles & system setup +# dotfiles & system setup -## UI +`git clone git@github.com:grawlinson/dotfiles.git ~/.dotfiles` -### General +Clone repository, then setup as desired. -* Numix Circle Icons -* Docky +## LICENSE -### XFCE - -* Topmenu -* Terminal -* Notifications (Numix) - -## TODO - -Refactor the following: - -* Weechat - -Create shell scripts that automatically: - -* Installs software from repositories -* Sets up UI - -Variables/Functions: - -* DOTFILES_DIR -* createFolder(location, folderName) - Backup if exists. -* createLink(location, fileName) - Backup if exists. -* Backup to: DOTFILES_DIR/BACKUPS (Add folder to gitignore) +The MIT License ([MIT](LICENSE.md)) diff --git a/npm/README.md b/npm/README.md index f93a049..0f514e0 100644 --- a/npm/README.md +++ b/npm/README.md @@ -7,9 +7,9 @@ Create directory for global packages `mkdir ~/.npm-packages` -Create a symlink for `.npmrc` +Copy `.npmrc` -`ln -s ~/.dotfiles/npm/npmrc ~/.npmrc` +`cp ~/.dotfiles/npm/npmrc ~/.npmrc` Shell wizardry diff --git a/ssh/README.md b/ssh/README.md index c4d283c..74e1440 100644 --- a/ssh/README.md +++ b/ssh/README.md @@ -8,7 +8,7 @@ Create SSH directory & copy config there. Generate SSH key(s) -`ssh-keygen -t rsa -b 4096 -C "comment" -f /path/to/ssh/key` +`ssh-keygen -t ed25519 -C "comment" -f /path/to/ssh/key` ## TODO diff --git a/xfce4/README.md b/xfce4/README.md index bb91b9a..173c07b 100644 --- a/xfce4/README.md +++ b/xfce4/README.md @@ -1,5 +1,8 @@ # xfce4 +**Obsolete**: I've since switched to KDE Plasma 5. +The X11 files are still useful. + ## General * Ensure notifications work properly. ([Reference][2] & [Source][1])