From a4e4ee477b493e0bfe147ed3a63609fe21b9858f Mon Sep 17 00:00:00 2001 From: "D. Scott Boggs" Date: Fri, 1 Sep 2023 06:04:05 -0400 Subject: [PATCH 1/4] 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 -- 2.43.5 From d8bc00833321c8021d4f4f15cad2b55a03f4dacd Mon Sep 17 00:00:00 2001 From: "D. Scott Boggs" Date: Fri, 1 Sep 2023 06:10:01 -0400 Subject: [PATCH 2/4] Create empty .gitignore file --- .gitignore | 2 ++ README.md | 4 ---- 2 files changed, 2 insertions(+), 4 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..582be7a --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# Add globs to files you don't want tracked to this file. Common examples +# include "**/node_modules", "*.secret", and ".env*". \ No newline at end of file diff --git a/README.md b/README.md index e9d1c8e..3a87646 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,6 @@ the top-right of the Forgejo page for the repository. ![Forgejo fork button](htt ```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 -- 2.43.5 From a31d4849490dbed263d82c9ceb9fa79176cebbdb Mon Sep 17 00:00:00 2001 From: "D. Scott Boggs" Date: Fri, 1 Sep 2023 06:21:21 -0400 Subject: [PATCH 3/4] Add forgotten `cd` command --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3a87646..13df12d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ the top-right of the Forgejo page for the repository. ![Forgejo fork button](htt $ git clone https://git.tams.tech/{USER}/{REPO}.git $ # Via SSH: $ git clone ssh://git@git.tams.tech:2222/{USER}/{REPO}.git + $ # either way, then do + $ cd {REPO} ``` Note that for private repositories, using HTTPS as the remote means entering your credentials at each fetch or push action. Remotes can always be -- 2.43.5 From 655031dfddc6c549f87efecf0c0c3529273324fa Mon Sep 17 00:00:00 2001 From: "D. Scott Boggs" Date: Sat, 2 Sep 2023 09:53:24 -0400 Subject: [PATCH 4/4] Try again --- .forgejo/template | 1 + README.md | 57 +++++++++++++++++++++-------------------------- 2 files changed, 26 insertions(+), 32 deletions(-) create mode 100644 .forgejo/template diff --git a/.forgejo/template b/.forgejo/template new file mode 100644 index 0000000..b43bf86 --- /dev/null +++ b/.forgejo/template @@ -0,0 +1 @@ +README.md diff --git a/README.md b/README.md index 13df12d..35843d7 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,28 @@ -# Template +# $REPO_NAME_TITLE -A template to use when creating new repositories. +$REPO_DESCRIPTION -# What's next? +## Prerequisites + +**TODO:** note any prerequisites here or delete this section + +## Installation + +**TODO:** write instructions for compiling from source and/or downloading + +## Development + +**TODO:** add any development-specific notes here + +## Contributing + +1. Fork it, if you don't have push access to this repo. +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request + +## Contributors + + - [$REPO_OWNER_TITLE](https://git.tams.tech/$REPO_OWNER) -- 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 - $ # either way, then do - $ cd {REPO} - ``` - 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 - ``` -- 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 -- 2.43.5