readme
This commit is contained in:
62
README.md
62
README.md
@@ -7,9 +7,9 @@ There is no place like $HOME. Home directory setup and bootstrapping guide.
|
||||
## Table of Contents
|
||||
|
||||
* [XDG](#xdg)
|
||||
* [Directories](#directories)
|
||||
* [Full Install](#full-install)
|
||||
* [Dotfiles](#dotfiles)
|
||||
* [Usage](#usage)
|
||||
* [Bootstrap](#bootstrap)
|
||||
* [Acknowledgments](#acknowledgments)
|
||||
* [License](#license)
|
||||
|
||||
@@ -29,30 +29,58 @@ You can find the original `/etc/xdg/xdg-user-dirs.defaults`[Here](https://myrepo
|
||||
You can find the custom `/etc/xdg/xdg-user-dirs.defaults`[Here](https://myrepos.dev/Randy-Jordan/eg/raw/branch/main/xdg/user-dirs.custom)
|
||||
|
||||
Here is an easy script to automate the download and replacement of the defaults.
|
||||
`curl https://myrepos.dev/Randy-Jordan/sh/raw/branch/main/rehome.sh | bash`
|
||||
|
||||
## Directories
|
||||
`curl -fsSL https://myrepos.dev/Randy-Jordan/sh/raw/branch/main/xdg_custom.sh | /bin/bash`
|
||||
|
||||
## Full Install
|
||||
Once you've got your home directories setup, you may want to download all
|
||||
needed packages from apt. Here is a script to automate a full install.
|
||||
|
||||
`curl -fsSL https://myrepos.dev/Randy-Jordan/sh/raw/branch/main/full_install.sh | /bin/bash`
|
||||
|
||||
## Dotfiles
|
||||
Now that we've got all the needed packages. Lets take care of our dotfiles. I
|
||||
will be following the guide in the acknowledgments.
|
||||
|
||||
## Usage
|
||||
|
||||
Provide instructions and examples on how to use your project.
|
||||
From scratch.
|
||||
|
||||
```bash
|
||||
# Example installation
|
||||
git clone https://github.com/your-username/your-repo.git
|
||||
|
||||
# Navigate into the directory
|
||||
cd your-repo
|
||||
|
||||
# Run the project
|
||||
npm install
|
||||
npm start
|
||||
git init --bare $HOME/.dot
|
||||
alias config='/usr/bin/git --git-dir=$HOME/.dot/ --work-tree=$HOME'
|
||||
config config --local status.showUntrackedFiles no
|
||||
echo "alias config='/usr/bin/git --git-dir=$HOME/.dot/ --work-tree=$HOME'" >> $HOME/.bashrc
|
||||
```
|
||||
|
||||
You can also include code snippets or screenshots demonstrating usage.
|
||||
Now add all of your dotfiles. Here is a snippet to make things easier.
|
||||
|
||||
`curl -fsSL https://myrepos.dev/Randy-Jordan/sh/raw/branch/main/init_dot.sh | /bin/bash`
|
||||
|
||||
Here is how you can migrate this setup to another system.
|
||||
|
||||
```bash
|
||||
git clone --bare https://myrepos.dev/Randy-Jordan/dot.git $HOME/.dot
|
||||
function config {
|
||||
/usr/bin/git --git-dir=$HOME/.dot/ --work-tree=$HOME $@
|
||||
}
|
||||
mkdir -p .config-backup
|
||||
config checkout
|
||||
if [ $? = 0 ]; then
|
||||
echo "Checked out config.";
|
||||
else
|
||||
echo "Backing up pre-existing dot files.";
|
||||
config checkout 2>&1 | egrep "\s+\." | awk {'print $1'} | xargs -I{} mv {} .config-backup/{}
|
||||
fi;
|
||||
config checkout
|
||||
config config status.showUntrackedFiles no
|
||||
```
|
||||
|
||||
And here is that in a snippet as well.
|
||||
`curl -fsSL https://myrepos.dev/Randy-Jordan/sh/raw/branch/main/init_dl.sh | /bin/bash`
|
||||
|
||||
## Bootstrap
|
||||
Here is a script to automate all of this.
|
||||
|
||||
`curl -fsSL https://myrepos.dev/Randy-Jordan/sh/raw/branch/main/bootstrap.sh | /bin/bash`
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
|
||||
Reference in New Issue
Block a user