docs(readme): add section for dir structure and license stuff
On the license stuff, I improved some text and also added an section for third-party code I used here and other repos integrated via Git submodules. Signed-off-by: Andrei Jiroh Eugenio Halili <ajhalili2006@gmail.com>
This commit is contained in:
parent
cccd25b29e
commit
52e42496cf
65
README.md
65
README.md
|
@ -25,17 +25,74 @@ $(command -v curl>>/dev/null && echo curl -o- || echo wget -q0-) https://ctrl-c.
|
|||
$(command -v curl>>/dev/null && echo curl -o- || echo wget -q0-) https://gitlab.com/ajhalili2006/dotfiles/raw/main/bootstrap | bash -
|
||||
```
|
||||
|
||||
## Directory Structure
|
||||
|
||||
```bash
|
||||
$ date && echo && tree -d .
|
||||
Saturday, 10 September, 2022 11:41:26 PM PST
|
||||
|
||||
.
|
||||
|-- bash-wakatime # TODO: Migrate to tools directory
|
||||
|-- bin # Scripts go here.
|
||||
|-- config # Configuration files, mostly not per distro, with exception of Termux and WSL2.
|
||||
| |-- bashrc
|
||||
| |-- byobu
|
||||
| |-- gitconfig
|
||||
| |-- konsole
|
||||
| |-- nanorc
|
||||
| | |-- config
|
||||
| | `-- highlighting
|
||||
| |-- ssh-client
|
||||
| |-- systemd
|
||||
| | `-- system
|
||||
| |-- tmux
|
||||
| `-- zshrc
|
||||
|-- docs # Markdown versions of my dotfiles docs at my Miraheze-hosted wiki
|
||||
| |-- additional-tools
|
||||
| `-- os-installation
|
||||
|-- gnupg # TODO: Migrate to config directory
|
||||
|-- nixos # TODO: Migrate to config directory
|
||||
|-- systemd -> config/systemd # TODO: Remove symlink soon
|
||||
|-- tests # Testing bootstrap scripts across distros
|
||||
| |-- alpine
|
||||
| |-- common
|
||||
| | `-- bin
|
||||
| `-- ubuntu
|
||||
|-- tools # A bit of homegrown tools and some other stuff I use
|
||||
| |-- bootstrap-utils
|
||||
| `-- setup-scripts
|
||||
`-- update-golang # TODO: Migrate to tools directory, might be deprecated due to usage of asdf/other tools
|
||||
|
||||
30 directories
|
||||
```
|
||||
|
||||
### Documentation
|
||||
|
||||
Available documentation for the on/offboarding processes I do for devices + other tidbits of the bootstrap script can be accessible through [the `docs` directory](./docs) and on [my personal wiki hosted on Miraheze](https://ajhalili2006.miraheze.org/wiki/Dotfiles).
|
||||
|
||||
## License and contributions
|
||||
|
||||
Code is licensed under [the MPL-2.0](LICENSE) license, while docs on my MediaWiki-powered wiki
|
||||
uses [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/legalcode).
|
||||
Code is licensed under [the MPL-2.0](LICENSE) license, while docs on my MediaWiki-powered wiki + here in this repository are licensed
|
||||
under [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/legalcode).
|
||||
|
||||
Patches are welcome, but technical support for forks is currently unavailable due to this repository
|
||||
being used for personal day-to-day use.
|
||||
Patches (either via GitLab merge requests or email patches via
|
||||
`~ajhalili2006/public-inbox@lists.sr.ht`) are welcome, but technical
|
||||
support for forks is currently unavailable due to this repository being
|
||||
used for personal day-to-day use.
|
||||
|
||||
### Third-party source code
|
||||
|
||||
Some of the code used in this dotfiles repository (and related repositories via Git submodules)
|
||||
uses third-party code, which might be licensed under other licenses, sometimes might not be compartible with
|
||||
the repository licenses.
|
||||
|
||||
* TBD
|
||||
* [Drew DeVault's Dotfiles][sircmpwn-df], specifically some [templates][sircmpwn-dt-aerc-templates] and [config for aerc][sircmpwn-dt-aerc]
|
||||
|
||||
[sircmpwn-df]: https://git.sr.ht/~sircmpwn/dotfiles
|
||||
[sircmpwn-dt-aerc-templates]: https://git.sr.ht/~sircmpwn/dotfiles/tree/.config/aerc/templates
|
||||
[sircmpwn-dt-aerc]: https://git.sr.ht/~sircmpwn/dotfiles/tree/.config/aerc
|
||||
---
|
||||
|
||||
<details>
|
||||
|
||||
|
|
Loading…
Reference in New Issue