Giter Club home page Giter Club logo

best-readme-template's Introduction

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Best-README-Template

An awesome README template to jumpstart your projects!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Product Name Screen Shot

There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others
  • You shouldn't be doing the same tasks over and over like creating a README from scratch
  • You should implement DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

Use the BLANK_README.md to get started.

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Next
  • React
  • Vue
  • Angular
  • Svelte
  • Laravel
  • Bootstrap
  • JQuery

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Get a free API Key at https://example.com
  2. Clone the repo
    git clone https://github.com/your_username_/Project-Name.git
  3. Install NPM packages
    npm install
  4. Enter your API in config.js
    const API_KEY = 'ENTER YOUR API';

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add Additional Templates w/ Examples
  • Add "components" document to easily copy & paste sections of the readme
  • Multi-language Support
    • Chinese
    • Spanish

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

(back to top)

best-readme-template's People

Contributors

abhisri7 avatar akarzim avatar batra-aarav avatar bay1877 avatar douglascayers avatar eduardoheleno avatar ferneynava avatar geovannig avatar ggtylerr avatar glennsvel90 avatar jpawlowski avatar kidonng avatar luisitoguanes avatar mohammedyh avatar othneildrew avatar rfrazier716 avatar shivgodhia avatar tariapper avatar vi-dev0 avatar viraatdas avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

best-readme-template's Issues

SyntaxError: JSON.parse: unexpected character at line 1 column 1 of the JSON data

FileManager
src/components/FileManager/FileManager.js:11

   8 | constructor(props) {
   9 |     super(props);
  10 |     this.state = {view: "Home", torrents: [], activeItem: {}};
> 11 |     this.username = JSON.parse(localStorage.getItem('autolycus-auth')).username;
     | ^  12 |     this.updateView = this.updateView.bind(this);
  13 | 
  14 |     this.timer = null;

image

publishing

hi everyone I am currently facing a problem with publishing. I attempted to view the website on localhost and it appeared to be functioning properly. Nevertheless, after uploading the website files to DreamHost, nothing seems to be appearing, what i am messing ?

Swapping email and email_client is required

Completing the instructions in order would result in a bug because replacing email would cause email_client to be not found. Replacing email_client is acceptable solution because email can also be found.

License shield not updating after license change

I used the template and replaced the original LICENSE.txt with a different license and did a find/replace in the readme text, but the license shield hasn't been updated and still reflects the original license type - is there a way to update it?

Strangely if I click on the shield URL in my editor, it shows me the correct badge, but the one on the readme shows the old one

Here's a link to the repo

سلام

سلام و سپاس از زحمات شما
من این ارور رو دارم . ممنون مشم راهنمایی بفرمایید
with io.open(outputfile, 'w', encoding='utf8') as f:
IsADirectoryError: [Errno 21] Is a directory: 'outputfile'

سپاس

Describe the bug

A clear and concise description of what the bug is.

Steps to reproduce

Steps to reproduce the behavior.

Expected behavior

A clear and concise description of what you expected to happen.

Environment

  • OS: [e.g. Arch Linux]
  • Other details that you think may affect.

Additional context

Add any other context about the problem here.

name attribute removed in HTML 5 for href tag

Describe the bug

The back to top link does not work correctly.

Steps to reproduce

  1. Copy/paste template into a markdown file
  2. Click any back to top link

Expected behavior

Jump back to the top due to this line

<a name="readme-top"></a>

Environment

  • OS: MacOS Sanoma - Version 14.4.1 (23E224)
  • Macbook - Apple M1 Pro

Additional context

I don't have time now, but I will fork, fix, and PR later today.

The fix, if anyone can do it sooner, is to change the line to

<a id="readme-top"></a>

Why?

Usage of the name attribute in this way is depreciated, and was removed from HTML 5 wikipedia

See here, here and here to verify

404 Page - Sidebar renders incorrectly

The sidebar of the 404 page renders the blog title un-responsively.

Page: 404.html

Result:

image

Expected Result:

The sidebar renders responsively like on all other pages.

I'd fix the issue myself and submit a request, but I'm not sure of the reason it's happening - I'm not a web developer. >.<

Could not find com.wei.android.lib:fingerprintidentify:1.2.6

Describe the bug

yarn android

Could not find com.wei.android.lib:fingerprintidentify:1.2.6.
Searched in the following locations:
- https://oss.sonatype.org/content/repositories/snapshots/com/wei/android/lib/fingerprintidentify/1.2.6/fingerprintidentify-1.2.6.pom
- https://repo.maven.apache.org/maven2/com/wei/android/lib/fingerprintidentify/1.2.6/fingerprintidentify-1.2.6.pom
- file:/Users/xianxianzhou/Desktop/xianxianE/starrymedia/UpwardWallet/rely-wallet/node_modules/jsc-android/dist/com/wei/android/lib/fingerprintidentify/1.2.6/fingerprintidentify-1.2.6.pom
- https://dl.google.com/dl/android/maven2/com/wei/android/lib/fingerprintidentify/1.2.6/fingerprintidentify-1.2.6.pom
- https://www.jitpack.io/com/wei/android/lib/fingerprintidentify/1.2.6/fingerprintidentify-1.2.6.pom
Required by:
project :app > project :react-native-fingerprint-scanner

File

Describe the bug

A clear and concise description of what the bug is.

Steps to reproduce

Steps to reproduce the behavior.

Expected behavior

A clear and concise description of what you expected to happen.

Environment

  • OS: [e.g. Arch Linux]
  • Other details that you think may affect.

Additional context

Add any other context about the problem here.

Giving credit to your proyect as explained in the MIT license.

Hello,

I would like to use your readme template for my proyects. This template uses the MIT license, which is perfect for me.

However, as explained on the MIT license, I need (and I wish to) give credit to you by pasting the MIT license text. Where should I give credit on a default proyect structure?

[Question] How did you learn about the [abc-shield] syntax?

Nice, clean README, thanks for sharing!

Curious, how did you know to use the shorthand syntax for rendering shields at the top of the document? I've been searching GitHub documentation but either it's not documented or I'm bad at searching, or both!

<!-- PROJECT SHIELDS -->
[![Build Status][build-shield]]()
[![Contributors][contributors-shield]]()
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]

Thanks

Configuring Redelivery in MassTransit for Individual Service Queues

I've been working with MassTransit and have encountered an issue that I'm unable to resolve myself.

In my system, I have multiple services running on a single virtual host. For various reasons, I want to ensure that the redelivery function is handled on separate queues for each service. In particular, I'm aiming to have a distinct Hangfire database for each one.

Could you provide me with guidance on how I can configure the redelivery such that each service can use its own separate queue?

I haven't been able to find clear answers on this in the documentation or through online searching, so any help would be appreciated.

Thanks in advance

[product-screenshot] on empty template

Hey, first of all thank you for publishing this! Awesome work :D

I realized that the "[product-screenshot]: images/screenshot.png" is missing on the empty template, so i wanted to let you know in case you could add it.

Hope you're doing ok,

Cheers.

Convert this project in "github template"

Hi

It will be very usefull if in repository settings, setup the project as Template.

Therefore any body can know that its a truth template when searching in github.

Thanks in advance

top section doesnt display for me

when i ported your amazing template and made my changes the top section doesnt display for me however its display fine when i'm viewing yours, i'm not sure if i'm doing anything wrong (included screenshots and my readme.md file code) [
Screenshot 2023-06-13 at 20-51-24 othneildrew_Best-README-Template An awesome README template to jumpstart your projects!
Screenshot 2023-06-13 at 20-51-03 autumn-skylight_codescape-app all in one app for developers made in electron 20 3 0 (first time using something other then plain html and scss_css
Code_zN7S2RwBY4

minor typo

Thanks to all the people have have contributed

Not Working On Android Device

Hi, This project is not working on android devices as packages not installed in window. Please check the issue below...

image

❤️

This is gold, thank you so much!

add permission

Hello, Maybe I added the authorization wrongly, but how exactly do I need to enter the server.cfg, which is correct?
No matter what I do, I get this back.
Screenshot_3
Thx Help! <3

Feedback Request on Recent Changes

Hi all,

I've made some recent changes to add a collapsible Table of Contents section. I try my best to stick with pure markdown, but this wasn't possible and uses HTML which complicates the process of updating and maintaining your readme overtime. Also, the referenced-styled markdown links have been a little confusing for some.

Please let me know what your thoughts are so I can make the appropriate changes. Ideally, I want the process to be as simple as possible.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.