Mercurial > hg > pub > prymula > com

annotate lamertetris/README.md @ 18:b5e2aba31fdb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
lamertetris-0.230821-3 package for arch
author Przemyslaw <prymula76@outlook.com>
date Sun, 31 Mar 2024 15:35:26 +0200
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
1 # lamertetris
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
2
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
3
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
4
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
5 ## Getting started
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
6
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
7 To make it easy for you to get started with GitLab, here's a list of recommended next steps.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
8
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
9 Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
10
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
11 ## Add your files
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
12
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
13 - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
14 - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
15
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
16 ```
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
17 cd existing_repo
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
18 git remote add origin https://gitlab.com/pietraszczyk/lamertetris.git
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
19 git branch -M main
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
20 git push -uf origin main
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
21 ```
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
22
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
23 ## Integrate with your tools
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
24
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
25 - [ ] [Set up project integrations](https://gitlab.com/pietraszczyk/lamertetris/-/settings/integrations)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
26
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
27 ## Collaborate with your team
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
28
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
29 - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
30 - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
31 - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
32 - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
33 - [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
34
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
35 ## Test and Deploy
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
36
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
37 Use the built-in continuous integration in GitLab.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
38
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
39 - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
40 - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
41 - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
42 - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
43 - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
44
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
45 ***
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
46
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
47 # Editing this README
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
48
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
49 When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
50
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
51 ## Suggestions for a good README
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
52
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
53 Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
54
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
55 ## Name
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
56 Choose a self-explaining name for your project.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
57
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
58 ## Description
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
59 Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
60
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
61 ## Badges
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
62 On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
63
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
64 ## Visuals
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
65 Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
66
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
67 ## Installation
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
68 Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
69
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
70 ## Usage
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
71 Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
72
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
73 ## Support
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
74 Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
75
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
76 ## Roadmap
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
77 If you have ideas for releases in the future, it is a good idea to list them in the README.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
78
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
79 ## Contributing
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
80 State if you are open to contributions and what your requirements are for accepting them.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
81
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
82 For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
83
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
84 You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
85
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
86 ## Authors and acknowledgment
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
87 Show your appreciation to those who have contributed to the project.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
88
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
89 ## License
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
90 For open source projects, say how it is licensed.
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
91
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
92 ## Project status
b5e2aba31fdb lamertetris-0.230821-3 package for arch
Przemyslaw <prymula76@outlook.com>
parents:
diff changeset
93 If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.