docs(readme): update links and formatting

Signed-off-by: Andrei Jiroh Halili <ajhalili2006@gmail.com>
This commit is contained in:
~ajhalili2006 2023-01-06 01:29:53 +08:00
parent b0ee16d81f
commit 2e7c34dba6
Signed by: ajhalili2006
GPG Key ID: 67BFC91B3DA12BE8
1 changed files with 27 additions and 10 deletions

View File

@ -5,11 +5,20 @@ to fix it in, built from scratch and based on <https://drewdevault.com/2019/12/3
## Available Git mirrors
TBD
This project is hosted on [hosted instance of sourcehut](https://sr.ht) at the
[`~ajhalili2006/dotfiles-modern`][git.sr.ht] Git repository, alongside the following
Git mirrors:
* mau.dev: <https://mau.dev/ajhalili2006/dotfiles-modern>
* Launchpad.net: <https://git.launchpad.net/ajhalili2006-dotfiles>
* ~vern git: <https://git.vern.cc/ajhalili2006/dotfiles-modern>
* tildegit: <https://tildegit.org/ajhalili2006/dotfiles-modern>
[git.sr.ht]: https://git.sr.ht/~ajhalili2006/dotfiles-modern
## Setup
It's easy, although this will be different because `git clone <clone-url-below>` will
It's easy, although this will be different because `git clone <clone-url-above>` will
scream some errors when attempt to do so after creating a user with their own home directory.
```bash
@ -18,7 +27,13 @@ cd ~
# init repo, add origin to git.sr.ht repo (have you got your SSH keys?)
git init
git remote add origin git@git.sr.ht:~ajhalili2006/dotfiles-refreshed-staging
git remote add origin git@git.sr.ht:~ajhalili2006/dotfiles-modern
# another route here is cloning the repo before the user creation take place
# so you can skip the "fetch and force checkout hellscape"
git clone git@git.sr.ht:~ajhalili2006/dotfiles-modern /home/ajhalili2006
# ...create user "ajhalili2006" here
chown ajhalili2006:ajhalili2006 -Rv /home/ajhalili2006
# fetch and force checkout
git fetch
@ -39,11 +54,13 @@ TL;DR before we dive in to legalese:
* Everything is licensed under both MIT + MPL 2.0, unless otherwise noted. Most third-party
code and submodules used here aren't covered by this policy.
* For contributors, either an agreement to the DCO (via `--signoff` flag on commits and when sending
email patches via `~ajhalili2006/public-inbox@lists.sr.ht`) or through signing the Recap Time Squad
[Individual CLA](https://go.recaptime.eu.org/cla/sign?type=individual) alongside this specific
[copyright transfer agreement on this project][cta-ajhalili2006-dotfiles] (requires separate signature
because the Copyright Assignment clause is not part of our CLAs but mentioned and not included by default in
most signatures) is mostly enough. Doing both is recommended to avoid further legal headaches down the line.
* Open source !== open contribution. Since this is just a personal project, expect your contributions to be
either rewritten or declined.
* For contributors who wish to send patches, either an agreement to the DCO (via `--signoff` flag on commits and
when sending email patches via `~ajhalili2006/public-inbox@lists.sr.ht`) or through signing the project-specific
[Individual CLA][sign-link] alongside this specific [copyright transfer agreement on this project][cta-ajhalili2006-dotfiles]
(requires separate signature, uses FSFe's FLA 2.0) is mostly enough. Doing both is recommended to avoid further legal headaches
down the line.
[cta-ajhalili2006-dotfiles]: https://go.recaptime.eu.org/cla/oss-cta/sign?project=ajhalili2006-dotfiles&require_cla_signature=true
[cta-ajhalili2006-dotfiles]: https://cla.recaptime.eu.org/sign/copyright-assignment?project=ajhalili2006-dotfiles&requireClaSignature=true&claType=FLA-FSFE
[sign-link]: https://cla.recaptime.eu.org/sign/per-project-basis?type=individual&project=ajhalili2006-dotfiles&claType=FLA-FSFE