Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Demo is not seeing #1

Open
jitendra3109 opened this issue Dec 14, 2016 · 1 comment
Open

Demo is not seeing #1

jitendra3109 opened this issue Dec 14, 2016 · 1 comment

Comments

@jitendra3109
Copy link

Where is your demo link? I could not able to reach there so please update readme file first. because you know with know a user can not waste their time to read code whether it is correct or wrong.
So please maintain the demo part in readme file.

@jitendra3109
Copy link
Author

In GitHub, if a Git repository has a README file in its main (top-level) directory, the README file is automatically converted into formatted HTML and presented on the main web page of the git repository, underneath the list of files and directories in the repository. Various different file extensions can be used, but there should not be more than one file named "README" at the top-level of a GitHub repository. The conversion to HTML takes account of the file extension of the file – for example, naming the README file for a GitHub repository "README.md" would cause GitHub to treat it as a GitHub-flavored Markdown file, which is also the default README file format on GitHub.
This makes using GitHub a low-effort way to create a web page for a git repository (GitHub also supports the publication of wikis and separate websites, which may be formatted however the developers want).
Because the GitHub web interface lets users edit a file in a relatively streamlined way, without manually cloning the repository and manually making a pull request, it supports wiki-style editing of the README file with approval necessary by a committer (i.e. someone who has write access to the repository) if the user is not a commit themselves.
However, within the GitHub app for Android mobile devices, the contents of README files are not shown underneath the list of files and nor are README files formatted as HTML when viewed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant