From 76a4034989dad983a71657520ae0fa451a67a423 Mon Sep 17 00:00:00 2001 From: Rohit Dhill Date: Fri, 1 Sep 2023 02:04:14 +0530 Subject: [PATCH] Add README.md to the repo --- README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0d5cabf --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Anticorp Wiki + +## What? +We run a private Discord/ XMPP/ Matrix server wherein most of our members post #resources related to a lot of cool stuff. That shit was getting out of control, in order to give #resources some structure and for the sake of longevity, it was mutually decided to spin up a Wiki for the same. + + +## Contribution + +### Contribution guidelines people who are members of Anticorpware + +- Clone the repository +```bash +$ git clone https://github.com/anticorpware/anticorp-wiki +``` + +- Install Hugo Extended version + +For more information, check their official [documentation](https://gohugo.io/installation/) + + +- Adding new content + +If you're not adding any content, just edit the files and follow the add-commit-push step afterwards + +```bash +$ hugo new 'docs/Learning Resources/filename.md' +``` + +- Update `filename.md` + +``` +--- +title: "Filename" +weight: 1 +# bookFlatSection: false +# bookToc: true +# bookHidden: false +# bookCollapseSection: false +# bookComments: false +# bookSearchExclude: false +--- + +# Filename + +### Resources +- This is a sample resource: [Link](https://example.com) +- This is another resource: [Link](https://example.com) +``` + +- Add your shit to the staging area, commit the changes and push it +``` +$ git add location/filename.md +$ git commit -S -m "Add a proper commit message" +$ git push -u origin main +``` + +### Contribution guidelines for non-members +Send a PR, most of the steps remain the same. 99.99% chances it will get rejected but we will accept PR from folks who +are a member of our private server but not of the GitHub organisation. +