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