Created
June 25, 2020 05:42
-
-
Save GeN-w-DeJA/f11ac8e91977dee69f48f87cffb287dd to your computer and use it in GitHub Desktop.
For Instantly share
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <!doctype html> | |
| <html lang=en> | |
| <head> | |
| <title>README.md</title> | |
| <meta charset=utf-8> | |
| <meta content="IE=edge,chrome=1"http-equiv=X-UA-Compatible> | |
| <meta content="width=device-width,initial-scale=1"name=viewport> | |
| <meta content=HTML,CSS,XML,JS,WALLPAPER,LOGO,GALLERY,STUDIOS,COLLECTION,SOCIAL,MEDIA name=Keywords> | |
| <meta content="Photography and graphics design and code learning"name=Description> | |
| <meta content=Gen-w-DeJA name=author> | |
| <meta content=README.md itemprop=name> | |
| <meta content="Photography and graphics design."itemprop=description> | |
| <meta content=summary name=twitter:card> | |
| <meta content=README.md name=twitter:title> | |
| <meta content="Photography and graphics design."name=twitter:description> | |
| <meta content=@Gen_GtNtGroup name=twitter:creator> | |
| <meta content=README.md property=og:title> | |
| <meta content="Photography and graphics design."property=og:description> | |
| <meta content=https://github.com/GeN-w-DeJA/GenXs/blob/master/README.md property=og:url> | |
| <meta content=README.md property=og:site_name> | |
| <meta content=website property=og:type> | |
| <meta content="https://vgicqa.dm.files.1drv.com/y4mbVMAAYQ8HpRw449RllhfoHUw8xUbZVq8elqaaQc61pzbYrmWjopHF0dfeZuap6f60skmJ_41H7_Fppr_E5PsxFi6ki9wqvXixS1NtG_XGdagG8_888istgCt68nU1Rjogsm3SOfZjsteN1aHUyVqITGuvcPo9CXfOi37KrTQhlW7FgANhFfeTZl11j2BEorRn2Q2h033zTLAvEw9RpiO0A/gs_06-11-2020_store290.gif?psid=1"property=og:image> | |
| <meta content=image/gif property=og:image:type> | |
| <meta content=60 property=og:image:width> | |
| <meta content=60 property=og:image:height> | |
| <link href=https://cdnjs.cloudflare.com/ajax/libs/bulma/0.7.2/css/bulma.min.css rel=stylesheet> | |
| <link href=https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css rel=stylesheet> | |
| <link href="https://fonts.googleapis.com/css?family=Open+Sans"rel=stylesheet> | |
| <link href=https://cdnjs.cloudflare.com/ajax/libs/github-markdown-css/2.10.0/github-markdown.min.css rel=stylesheet> | |
| <link href=https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.13.1/styles/hopscotch.min.css rel=stylesheet> | |
| <link href=https://d33wubrfki0l68.cloudfront.net/css/611b33e670dc1ef7e6087c951622a924ede18fab/index.css rel=stylesheet> | |
| <link href="https://fonts.googleapis.com/chttps://fonts.googleapis.com/css?family=Markaziss?family=Markazi Text"rel=stylesheet> | |
| <link href="https://fonts.googleapis.com/css?family=Source Code Pro"rel=stylesheet> | |
| <script src=https://kit.fontawesome.com/0e9acd0454.js crossorigin=anonymous> | |
| </script> | |
| <script src="https://cse.google.com/cse.js?cx=007483869223202516001:a2myf13cdmi"async> | |
| </script> | |
| <link href=https://maxcdn.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css rel=stylesheet> | |
| <script src=https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js> | |
| </script> | |
| <script src=https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.0/umd/popper.min.js> | |
| </script> | |
| <script src=https://maxcdn.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js> | |
| </script> | |
| <style> | |
| .github-corner:hover .octo-arm{animation:octocat-wave 560ms ease-in-out}@keyframes octocat-wave{0%,100%{transform:rotate(0)}20%,60%{transform:rotate(-25deg)}40%,80%{transform:rotate(10deg)}}@media (max-width:500px){.github-corner:hover .octo-arm{animation:none}.github-corner .octo-arm{animation:octocat-wave 560ms ease-in-out}} | |
| </style> | |
| </head> | |
| <body> <h1 class=title is-2 id=readme>README | |
| </h1> | |
| <section> | |
| <div> | |
| <a href=https://github.com/GeN-w-DeJA/GenXs/blob/master/README.md> | |
| <p class="is-4 subtitle">Before you start !... please read this first | |
| </p> | |
| </a> | |
| </div> | |
| </section> | |
| <div id=codefund> | |
| </div> | |
| <section class=section> | |
| <div class=container> | |
| <h2 class="title has-text-centered is-3">Introduction | |
| </h2> | |
| <h3 class="title is-4">What is it? | |
| </h3> | |
| <p>A | |
| <a href=https://en.wikipedia.org/wiki/README>README | |
| </a>is a text file that introduces and explains to any our Projects. For contains information that is commonly required to understand what the project is about. | |
| <h3 class="title is-4">Who is "gtntgroup"? | |
| </h3> | |
| <p>It's an easy way to answer this questions....this`s content have to regarding about how to use our project and also how to collaborate with us. | |
| <h3 class="title is-4">About "gtntgroup"(The General tech & Network technology group) | |
| </h3> | |
| <p>We are a group of people who want to spread And share the work without any profit. And everyone can join to share with us. | |
| <h3 class="title is-4">What's sharing it? | |
| </h3> | |
| <p>The first for this question..."Here you are!" Definitely before you show a project to other people or make it public. You might want to get into the habit of making it the | |
| <a href=http://tom.preston-werner.com/2010/08/23/readme-driven-development.html>first file you create | |
| </a>in a new project. | |
| <h3 class="title is-4">Where should I put it? | |
| </h3> | |
| <p>In the top level directory of the project. This is where someone who is new to your project will start out. Code hosting services such as | |
| <a href=https://github.com/ >GitHub | |
| </a>, | |
| <a href=https://bitbucket.org/ >Bitbucket | |
| </a>, and | |
| <a href=https://about.gitlab.com/ >GitLab | |
| </a>will also look for your README and display it along with the list of files and directories in your project. | |
| <h3 class="title is-4">How should I make it? | |
| </h3> | |
| <p>While READMEs can be written in any text file format, the most common one that is used nowadays is | |
| <a href=https://en.wikipedia.org/wiki/Markdown>Markdown | |
| </a>. It allows you to add some lightweight formatting. You can learn more about it | |
| <a href=http://commonmark.org/ >here | |
| </a>, which also has a helpful | |
| <a href=http://commonmark.org/help/ >reference guide | |
| </a>and an | |
| <a href=http://commonmark.org/help/tutorial/ >interactive tutorial | |
| </a>. Some other formats that you might see are | |
| <a href=https://en.wikipedia.org/wiki/Text_file>plain text | |
| </a>, | |
| <a href=https://en.wikipedia.org/wiki/ReStructuredText>reStructuredText | |
| </a>(common in | |
| <a href=https://www.python.org/ >Python | |
| </a>projects), and | |
| <a href=https://en.wikipedia.org/wiki/Textile_(markup_language)>Textile | |
| </a>. | |
| <p>You can use any text editor. There are plugins for many editors (e.g. | |
| <a href=https://github.com/atom/markdown-preview>Atom | |
| </a>, | |
| <a href=https://github.com/jrblevin/markdown-mode>Emacs | |
| </a>, | |
| <a href=https://github.com/revolunet/sublimetext-markdown-preview>Sublime Text | |
| </a>, | |
| <a href=https://github.com/suan/vim-instant-markdown>Vim | |
| </a>, and | |
| <a href=https://code.visualstudio.com/docs/languages/markdown#_markdown-preview>Visual Studio Code | |
| </a>) that allow you to preview Markdown while you are editing it. | |
| <p>You can also use a dedicated Markdown editor like | |
| <a href=https://typora.io/ >Typora | |
| </a>or an online one like | |
| <a href=https://stackedit.io/editor>StackEdit | |
| </a>or | |
| <a href=http://dillinger.io/ >Dillinger | |
| </a>. You can even use the editable template below. | |
| </div> | |
| </section> | |
| <section class=section id=template> | |
| <h2 class="title has-text-centered has-text-light">Template | |
| </h2> | |
| <div class=columns> | |
| <div class=column> | |
| <h3 class="title is-4 has-text-centered has-text-light">Markdown Input (editable) | |
| </h3> | |
| <textarea> # Foobar Foobar is a Python library for dealing with word pluralization. ## Installation Use the package manager [pip](https://pip.pypa.io/en/stable/) to install foobar. ```bash pip install foobar ``` ## Usage ```python import foobar foobar.pluralize('word') # returns 'words' foobar.pluralize('goose') # returns 'geese' foobar.singularize('phenomena') # returns 'phenomenon' ``` ## Contributing Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate. ## License [MIT](https://choosealicense.com/licenses/mit/) | |
| </textarea> | |
| </div> | |
| <div class=column> | |
| <h3 class="title is-4 has-text-centered has-text-light">Rendered | |
| </h3> | |
| <div class=markdown-body id=rendered> | |
| </div> | |
| </div> | |
| </div> | |
| </section> | |
| <section class=section> | |
| <div class=container> | |
| <h2 class="title has-text-centered is-3">Suggestions for a good README | |
| </h2> | |
| <p>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 | |
| <a href=#more-documentation>another form of documentation | |
| </a>rather than cutting out information. | |
| <h3 class="title is-4">Name | |
| </h3> | |
| <p>Choose a self-explaining name for your project. | |
| <h3 class="title is-4">Description | |
| </h3> | |
| <p>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 | |
| <b>Features | |
| </b>or a | |
| <b>Background | |
| </b>subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. | |
| <h3 class="title is-4">Badges | |
| </h3> | |
| <p>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 | |
| <a href=http://shields.io/ >Shields | |
| </a>to add some to your README. Many services also have instructions for adding a badge. | |
| <h3 class="title is-4">Visuals | |
| </h3> | |
| <p>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 | |
| <a href=https://github.com/icholy/ttygif>ttygif | |
| </a>can help, but check out | |
| <a href=https://asciinema.org/ >Asciinema | |
| </a>for a more sophisticated method. | |
| <h3 class="title is-4">Installation | |
| </h3> | |
| <p>Within a particular ecosystem, there may be a common way of installing things, such as using | |
| <a href=https://yarnpkg.com>Yarn | |
| </a>, | |
| <a href=https://www.nuget.org/ >NuGet | |
| </a>, or | |
| <a href=https://brew.sh/ >Homebrew | |
| </a>. 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 | |
| <b>Requirements | |
| </b>subsection. | |
| <h3 class="title is-4">Usage | |
| </h3> | |
| <p>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. | |
| <h3 class="title is-4">Support | |
| </h3> | |
| <p>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. | |
| <h3 class="title is-4">Roadmap | |
| </h3> | |
| <p>If you have ideas for releases in the future, it is a good idea to list them in the README. | |
| <h3 class="title is-4">Contributing | |
| </h3> | |
| <p>State if you are open to contributions and what your requirements are for accepting them. | |
| <p>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. | |
| <p>You can also document commands to | |
| <a href=https://stackoverflow.com/questions/8503559/what-is-linting>lint the code | |
| </a>or | |
| <a href=https://en.wikipedia.org/wiki/Test_automation>run tests | |
| </a>. 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 | |
| <a href=http://www.seleniumhq.org/ >Selenium | |
| </a>server for testing in a browser. | |
| <h3 class="title is-4">Authors and acknowledgment | |
| </h3> | |
| <p>Show your appreciation to those who have contributed to the project. | |
| <h3 class="title is-4">License | |
| </h3> | |
| <p>For open source projects, say how it is | |
| <a href=#license-1>licensed | |
| </a>. | |
| <h3 class="title is-4">Project status | |
| </h3> | |
| <p>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. | |
| </div> | |
| </section> | |
| <section class=section id=faq> | |
| <h2 class="title has-text-centered has-text-light">FAQ | |
| </h2> | |
| <article class="is-warning message"> | |
| <h3 class=message-header>Is there a standard README format? | |
| </h3> | |
| <div class=message-body>Not all of the suggestions here will make sense for every project, so it's really up to the developers what information should be included in the README. | |
| </div> | |
| </article> | |
| <article class="is-warning message"> | |
| <h3 class=message-header>What are some other thoughts on writing READMEs? | |
| </h3> | |
| <div class=message-body>Check out | |
| <a href=https://github.com/matiassingers/awesome-readme>Awesome README | |
| </a>for a list of more resources. | |
| </div> | |
| </article> | |
| <article class="is-warning message"> | |
| <h3 class=message-header>What should the README file be named? | |
| </h3> | |
| <div class=message-body> | |
| <code>README.md | |
| </code> (or a different file extension if you choose to use a non-Markdown file format). It is | |
| <a href=https://softwareengineering.stackexchange.com/q/301691/298927>traditionally uppercase | |
| </a>so that it is more prominent, but it's not a big deal if you think it | |
| <a href=https://github.com/sindresorhus/ama/issues/197>looks better lowercase | |
| </a>. | |
| </div> | |
| </article> | |
| <article class="is-warning message"> | |
| <h3 class=message-header>What if I disagree with something, want to make a change, or have any other feedback? | |
| </h3> | |
| <div class=message-body>Please don't hesitate to open an | |
| <a href=https://github.com/dguo/make-a-readme/issues>issue | |
| </a>or | |
| <a href=https://github.com/dguo/make-a-readme/pulls>pull request | |
| </a>. You can also send me a message on | |
| <a href=https://twitter.com/dannyguo>Twitter | |
| </a>. | |
| </div> | |
| </article> | |
| <article class="is-warning message"> | |
| <h3 class=message-header>Mind reading? | |
| </h3> | |
| <div class=message-body> | |
| <a href=https://www.usatoday.com/story/tech/2014/04/22/mind-reading-brain-scans/7747831/ >Scientists | |
| </a>and companies like | |
| <a href=https://www.theverge.com/2017/4/20/15375176/facebook-regina-dugan-interview-building-8-mind-reading-f8-2017>Facebook | |
| </a>and | |
| <a href=https://www.neuralink.com/ >Neuralink | |
| </a>(presumably) are working on it. Perhaps in the future, you'll be able to attach a copy of your thoughts and/or consciousness to your projects. In the meantime, please make READMEs. | |
| </div> | |
| </article> | |
| </section> | |
| <section class=section> | |
| <div class=container> | |
| <h2 class="title has-text-centered">What's next? | |
| </h2> | |
| <h3 class="title is-4">License | |
| </h3> | |
| <p>If your project is | |
| <a href=https://en.wikipedia.org/wiki/Open-source_software>open source | |
| </a>, it's | |
| <a href=https://blog.codinghorror.com/pick-a-license-any-license/ >important | |
| </a>to include a | |
| <a href=https://en.wikipedia.org/wiki/Open-source_license>license | |
| </a>. You can use | |
| <a href=https://choosealicense.com/ >this website | |
| </a>to help you pick one. | |
| <h3 class="title is-4">Changelog | |
| </h3> | |
| <p>Make a README is inspired by | |
| <a href=http://keepachangelog.com/ >Keep a Changelog | |
| </a>. A | |
| <a href=https://en.wikipedia.org/wiki/Changelog>changelog | |
| </a>is another file that is very useful for programming projects. | |
| <h3 class="title is-4">More Documentation | |
| </h3> | |
| <p>A README is a crucial but basic way of documenting your project. While every project should at least have a README, more involved ones can also benefit from a | |
| <a href=https://en.wikipedia.org/wiki/Wiki>wiki | |
| </a>or a dedicated documentation website. | |
| <a href=https://help.github.com/articles/about-github-wikis/ >GitHub | |
| </a>, | |
| <a href=https://confluence.atlassian.com/bitbucket/use-a-wiki-221449748.html>Bitbucket | |
| </a>, and | |
| <a href=https://docs.gitlab.com/ce/user/project/wiki/index.html>GitLab | |
| </a>all support maintaining a wiki alongside your project, and here are some tools and services that can help you generate a documentation website: | |
| <div class=content> | |
| <ul> | |
| <li> | |
| <a href=https://dauxio.github.io/ >Daux.io | |
| </a> | |
| <li> | |
| <a href=https://docusaurus.io/ >Docusaurus | |
| </a> | |
| <li> | |
| <a href=https://www.gitbook.com/ >GitBook | |
| </a> | |
| <li> | |
| <a href=https://www.mkdocs.org/ >MkDocs | |
| </a> | |
| <li> | |
| <a href=https://readthedocs.org/ >Read the Docs | |
| </a> | |
| <li> | |
| <a href=https://readme.io/ >ReadMe | |
| </a> | |
| <li> | |
| <a href=https://github.com/lord/slate>Slate | |
| </a> | |
| </ul> | |
| </div> | |
| <h3 class="title is-4">Contributing | |
| </h3> | |
| <p>( | |
| <code>CONTRIBUTING.md | |
| </code>). If you use GitHub and have this file, then anyone who creates an issue or opens a pull request | |
| <a href=https://help.github.com/articles/setting-guidelines-for-repository-contributors/ >will get a link | |
| </a>to it. | |
| <p>You can also create an | |
| <a href=https://help.github.com/articles/creating-an-issue-template-for-your-repository/ >issue template | |
| </a>and a | |
| <a href=https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/ >pull request template | |
| </a>. These files give your users and collaborators templates to fill in with the information that you'll need to properly respond. This helps to avoid situations like getting very vague issues. Both GitHub and | |
| <a href=https://docs.gitlab.com/ce/user/project/description_templates.html>GitLab | |
| </a>will use the templates automatically. | |
| </div> | |
| </section> | |
| <footer class="content footer has-background-light has-text-centered"id=footer> | |
| <p>Make a README is maintained by | |
| <a href=https://www.gtntgroup.com>gtntgroup.com | |
| </a> | |
| <a href=https://github.com/GeN-w-DeJA/GenXs/blob/master/README.md>GitHub | |
| </a> | |
| </footer> | |
| <pre> | |
| <code> | |
| <pre> | |
| <code> | |
| <pre> | |
| <code> | |
| <pre> | |
| <code> | |
| <pre> | |
| <code> | |
| <pre> | |
| <code> | |
| </code> | |
| </pre> | |
| </code> | |
| </pre> | |
| </code> | |
| </pre> | |
| </code> | |
| </pre> | |
| </code> | |
| </pre> | |
| </code> | |
| </pre> | |
| </body> | |
| </html> |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment