From a4e4ee477b493e0bfe147ed3a63609fe21b9858f Mon Sep 17 00:00:00 2001 From: "D. Scott Boggs" Date: Fri, 1 Sep 2023 06:04:05 -0400 Subject: [PATCH] Update README --- README.md | 38 ++++++++++++++++++++++++++++++++++++-- 1 file changed, 36 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c663a82..e9d1c8e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,37 @@ -# template +# Template -A template to use when creating new repositories. \ No newline at end of file +A template to use when creating new repositories. + +# What's next? + +- Unless this is a private repository, fork it by clicking the Fork button in +the top-right of the Forgejo page for the repository. ![Forgejo fork button](https://s.tams.tech/forgejo-fork.png) +- Copy the repository URL from the Forgejo interface ![Forgejo clone link](https://s.tams.tech/forgejo-clone-link.png) +- Clone the repository locally, and change your shell's directory to it. + ```console + $ # Via https: + $ git clone https://git.tams.tech/{USER}/{REPO}.git + $ # Via SSH: + $ git clone ssh://git@git.tams.tech:2222/{USER}/{REPO}.git + ``` + Note that for private repositories, using HTTPS as the remote means entering + your credentials at each fetch or push action. Remotes can always be + updated, see [`git-remote(1)`](https://git-scm.com/docs/git-remote) for more + info. +- Create a new branch + ```console + $ git checkout -b repo-init + ``` +- Create a `.gitignore` file + ```console + $ touch .gitignore + ``` +- Replace the contents of this README with some information about what the repo is. +- Commit your changes, and push them + ```console + $ git add README.md .gitignore + $ git commit -m "Initialized repository" + $ git push origin repo-init + ``` +- Click the link in the console output to create a pull request, then send a + link to that to the group chat to request review. \ No newline at end of file