[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/base32 8f865c378e 001/103: Initial commit
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/base32 8f865c378e 001/103: Initial commit |
Date: |
Sat, 10 Feb 2024 12:59:47 -0500 (EST) |
branch: elpa/base32
commit 8f865c378ee0503633632e4de4f1a6ef47de7615
Author: Vivek Das Mohapatra <vivek@collabora.com>
Commit: Vivek Das Mohapatra <vivek@collabora.com>
Initial commit
---
README.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 92 insertions(+)
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..8e2397b639
--- /dev/null
+++ b/README.md
@@ -0,0 +1,92 @@
+# totp.el
+
+
+
+## Getting started
+
+To make it easy for you to get started with GitLab, here's a list of
recommended next steps.
+
+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)!
+
+## Add your files
+
+- [ ]
[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
+- [ ] [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:
+
+```
+cd existing_repo
+git remote add origin https://gitlab.com/fledermaus/totp.el.git
+git branch -M main
+git push -uf origin main
+```
+
+## Integrate with your tools
+
+- [ ] [Set up project
integrations](https://gitlab.com/fledermaus/totp.el/-/settings/integrations)
+
+## Collaborate with your team
+
+- [ ] [Invite team members and
collaborators](https://docs.gitlab.com/ee/user/project/members/)
+- [ ] [Create a new merge
request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+- [ ] [Automatically close issues from merge
requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
+- [ ] [Enable merge request
approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
+- [ ] [Automatically merge when pipeline
succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+- [ ] [Get started with GitLab
CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
+- [ ] [Analyze your code for known vulnerabilities with Static Application
Security
Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
+- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto
Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
+- [ ] [Use pull-based deployments for improved Kubernetes
management](https://docs.gitlab.com/ee/user/clusters/agent/)
+- [ ] [Set up protected
environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+
+***
+
+# Editing this README
+
+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!). Thank you to
[makeareadme.com](https://www.makeareadme.com/) for this template.
+
+## Suggestions for a good README
+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.
+
+## Name
+Choose a self-explaining name for your project.
+
+## Description
+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.
+
+## Badges
+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.
+
+## Visuals
+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.
+
+## Installation
+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 ma [...]
+
+## Usage
+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.
+
+## Support
+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.
+
+## Roadmap
+If you have ideas for releases in the future, it is a good idea to list them
in the README.
+
+## Contributing
+State if you are open to contributions and what your requirements are for
accepting them.
+
+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.
+
+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.
+
+## Authors and acknowledgment
+Show your appreciation to those who have contributed to the project.
+
+## License
+For open source projects, say how it is licensed.
+
+## Project status
+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.
- [nongnu] branch elpa/base32 created (now 5fa6529ace), ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 8d27869a96 002/103: Initial check in of TOTP token generation, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 4595bb3b7c 008/103: Make the returned TOTP token a string so we don't lose leading 0s, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 93aa724afe 011/103: Improve the UI to display a constantly updated TOTP token, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 8b74f66db2 014/103: Update README, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 614354718d 007/103: Make totp-generate-otp understand secret structs and base32 strings, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 8f865c378e 001/103: Initial commit,
ELPA Syncer <=
- [nongnu] elpa/base32 545cf69323 004/103: Simplify the totp-secrets-create-item-workaround custom entry, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 2ded2a7cef 003/103: Replace generic gitlab README with something more useful, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 34d9df6232 006/103: Split out the standard label generation code, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 0146fe6b91 010/103: Minor formatting trivia in the test file, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 b7e1daca76 009/103: Comment out some spurious calls in the test file, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 4432d44bce 012/103: Trivia: clean up some docstrings, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 a683df1a74 013/103: Add a separate instance of an `auth-sources' list just for TOTP, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 5c902928f7 017/103: Fix bug in otpauth-migration URL decoder, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 f27043d432 019/103: Fix some byte compilation warnings, ELPA Syncer, 2024/02/10
- [nongnu] elpa/base32 417a3d03f6 020/103: Dedup secrets manually instead of relying on freedesktop secrets API, ELPA Syncer, 2024/02/10