<section>
<div>
[
<p class="is-4 subtitle">Before you start !... please read this first
</p>
](https://github.com/GeN-w-DeJA/GenXs/blob/master/README.md)
</div>
</section>
<div id="codefund">
</div>
<section class="section">
<div class="container">
## Introduction
### What is it?
A
[README
](https://en.wikipedia.org/wiki/README)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.
### Who is "gtntgroup"?
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.
### About "gtntgroup"(The General tech & Network technology group)
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.
### What's sharing it?
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
[first file you create
](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)in a new project.
### Where should I put it?
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
[GitHub
](https://github.com/),
[Bitbucket
](https://bitbucket.org/), and
[GitLab
](https://about.gitlab.com/)will also look for your README and display it along with the list of files and directories in your project.
### How should I make it?
While READMEs can be written in any text file format, the most common one that is used nowadays is
[Markdown
](https://en.wikipedia.org/wiki/Markdown). It allows you to add some lightweight formatting. You can learn more about it
[here
](http://commonmark.org/), which also has a helpful
[reference guide
](http://commonmark.org/help/)and an
[interactive tutorial
](http://commonmark.org/help/tutorial/). Some other formats that you might see are
[plain text
](https://en.wikipedia.org/wiki/Text_file),
[reStructuredText
](https://en.wikipedia.org/wiki/ReStructuredText)(common in
[Python
](https://www.python.org/)projects), and
[Textile
](https://en.wikipedia.org/wiki/Textile_(markup_language)).
You can use any text editor. There are plugins for many editors (e.g.
[Atom
](https://github.com/atom/markdown-preview),
[Emacs
](https://github.com/jrblevin/markdown-mode),
[Sublime Text
](https://github.com/revolunet/sublimetext-markdown-preview),
[Vim
](https://github.com/suan/vim-instant-markdown), and
[Visual Studio Code
](https://code.visualstudio.com/docs/languages/markdown#_markdown-preview)) that allow you to preview Markdown while you are editing it.
You can also use a dedicated Markdown editor like
[Typora
](https://typora.io/)or an online one like
[StackEdit
](https://stackedit.io/editor)or
[Dillinger
](http://dillinger.io/). You can even use the editable template below.
### Markdown Input (editable)
<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>
### Rendered
## 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
](#more-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
](http://shields.io/)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
](https://github.com/icholy/ttygif)can help, but check out
[Asciinema
](https://asciinema.org/)for a more sophisticated method.
### Installation
Within a particular ecosystem, there may be a common way of installing things, such as using
[Yarn
](https://yarnpkg.com),
[NuGet
](https://www.nuget.org/), or
[Homebrew
](https://brew.sh/). 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.
### 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
](https://stackoverflow.com/questions/8503559/what-is-linting)or
[run tests
](https://en.wikipedia.org/wiki/Test_automation). 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
](http://www.seleniumhq.org/)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
](#license-1).
### 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.
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.
### What are some other thoughts on writing READMEs?
Check out
[Awesome README
](https://github.com/matiassingers/awesome-readme)for a list of more resources.
### What should the README file be named?
`README.md
` (or a different file extension if you choose to use a non-Markdown file format). It is
[traditionally uppercase
](https://softwareengineering.stackexchange.com/q/301691/298927)so that it is more prominent, but it's not a big deal if you think it
[looks better lowercase
](sindresorhus/ama#197).
### What if I disagree with something, want to make a change, or have any other feedback?
Please don't hesitate to open an
[issue
](https://github.com/dguo/make-a-readme/issues)or
[pull request
](https://github.com/dguo/make-a-readme/pulls). You can also send me a message on
[Twitter
](https://twitter.com/dannyguo).
### Mind reading?
[Scientists
](https://www.usatoday.com/story/tech/2014/04/22/mind-reading-brain-scans/7747831/)and companies like
[Facebook
](https://www.theverge.com/2017/4/20/15375176/facebook-regina-dugan-interview-building-8-mind-reading-f8-2017)and
[Neuralink
](https://www.neuralink.com/)(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.
## What's next?
### License
If your project is
[open source
](https://en.wikipedia.org/wiki/Open-source_software), it's
[important
](https://blog.codinghorror.com/pick-a-license-any-license/)to include a
[license
](https://en.wikipedia.org/wiki/Open-source_license). You can use
[this website
](https://choosealicense.com/)to help you pick one.
### Changelog
Make a README is inspired by
[Keep a Changelog
](http://keepachangelog.com/). A
[changelog
](https://en.wikipedia.org/wiki/Changelog)is another file that is very useful for programming projects.
### More Documentation
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
[wiki
](https://en.wikipedia.org/wiki/Wiki)or a dedicated documentation website.
[GitHub
](https://help.github.com/articles/about-github-wikis/),
[Bitbucket
](https://confluence.atlassian.com/bitbucket/use-a-wiki-221449748.html), and
[GitLab
](https://docs.gitlab.com/ce/user/project/wiki/index.html)all support maintaining a wiki alongside your project, and here are some tools and services that can help you generate a documentation website:
-
[Daux.io
](https://dauxio.github.io/)
-
[Docusaurus
](https://docusaurus.io/)
-
[GitBook
](https://www.gitbook.com/)
-
[MkDocs
](https://www.mkdocs.org/)
-
[Read the Docs
](https://readthedocs.org/)
-
[ReadMe
](https://readme.io/)
-
[Slate
](https://github.com/lord/slate)
</div>
### Contributing
(
`CONTRIBUTING.md
`). If you use GitHub and have this file, then anyone who creates an issue or opens a pull request
[will get a link
](https://help.github.com/articles/setting-guidelines-for-repository-contributors/)to it.
You can also create an
[issue template
](https://help.github.com/articles/creating-an-issue-template-for-your-repository/)and a
[pull request template
](https://help.github.com/articles/creating-a-pull-request-template-for-your-repository/). 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
[GitLab
](https://docs.gitlab.com/ce/user/project/description_templates.html)will use the templates automatically.
``