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.

Sign up for GitHub

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

Updated new readme.md #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated new readme.md #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 57 additions & 53 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,84 +1,88 @@

# Readme Best Practices
> A place to copy-paste your README.md from

One of the most crucial things in your open-source project is the `README.md`
file. This repository has a ready-to-copy-paste template you can use for all
your projects.
> A comprehensive template to craft a professional README.md for your project.

## Getting started
A well-structured `README.md` file is essential for any open-source project. This repository provides a robust template that you can use and customize for all your projects.

Copy the `README-default.md` file for yourself and start editing! At the root of
your project, run:
## Table of Contents

```shell
curl https://raw.githubusercontent.com/jehna/readme-best-practices/master/README-default.md > README.md
```
- [Getting Started](#getting-started)
- [Features](#features)
- [Usage](#usage)
- [Contributing](#contributing)
- [Related Projects](#related-projects)
- [License](#license)

## Getting Started

The code above fetches the `README-default.md` file from this repository and
renames it to `README.md`.
### 1. Copy the Template

To begin, you can copy the default template provided in this repository and modify it according to your project needs. Run the following command in your project root directory to download the template:

```bash
curl -O https://raw.githubusercontent.com/jehna/readme-best-practices/master/README-default.md
mv README-default.md README.md
```

## Fill with your own text
### 2. Customize the Template

The default template has some guiding text to get you started. However, you'll
need to edit the file with your own text to use it with your project.
Open the downloaded `README.md` file in your preferred markdown editor and update it with information specific to your project.

```shell
```bash
code README.md
```

If you're using [VS Code](https://code.visualstudio.com/) code editor, the code above opens the
file for editing. If necessary, substitute with your preferred markdown editor.
> **Note:** The command above opens the file in [VS Code](https://code.visualstudio.com/). If you're using a different editor, replace `code` with the appropriate command.

### Add to git and push
### 3. Save and Push Changes

After you've filled your `README.md` file with your own project's text, you
should push it to your GitHub project:
Once you've customized your `README.md`, add it to your repository and push the changes to your remote repository.

```shell
```bash
git add README.md
git commit -m "Added: README"
git push
git commit -m "docs: add customized README.md"
git push origin main
```

This adds the `README.md` file to your git repository, creates a commit for it
and pushes it to GitHub (or your preferred remote repository).

## Features

This project makes it easy to:
* Bootstrap your open-source project properly
* Make sure everyone gets what you're trying to achieve with your project
* Follow simple instructions for a perfect `README.md`
This repository helps you:

## Contributing
- **Kickstart your project** with a ready-to-use README template.
- **Clarify your project's purpose** to the community.
- **Ensure consistency** across all your open-source projects with a standardized README format.

## Usage

As I use this for my own projects, I know this might not be the perfect approach
for all the projects out there. If you have any ideas, just
[open an issue][issues] and tell me what you think.
1. **Download the Template**: Use the command provided in the [Getting Started](#getting-started) section.
2. **Edit the README**: Update the template with project-specific information like a description, installation instructions, usage, and more.
3. **Add to Version Control**: Track the changes in your version control system and push it to your remote repository.

## Contributing

If you'd like to contribute, please fork the repository and make changes as
you'd like. Pull requests are warmly welcome.
We welcome contributions! If you have suggestions for improvements or new features, please [open an issue][issues] to discuss your ideas.

If your vision of a perfect `README.md` differs greatly from mine, it might be
because your projects are vastly different. In this case, you can create a
new file `README-yourplatform.md` and create the perfect boilerplate for that.
### How to Contribute

E.g. if you have a perfect `README.md` for a Grunt project, just name it as
`README-grunt.md`.
1. Fork the repository.
2. Create a new feature branch: `git checkout -b feature/your-feature-name`.
3. Make your changes.
4. Commit your changes: `git commit -m "feat: add your feature description"`.
5. Push to the branch: `git push origin feature/your-feature-name`.
6. Create a pull request.

## Related projects
## Related Projects

Here's a list of other related projects where you can find inspiration for
creating the best possible README for your own project:
Here are some other projects that provide excellent examples or templates for creating a high-quality README:

- [Billie Thompson's README template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
- [A list of awesome READMEs](https://github.com/matiassingers/awesome-readme)
- [Akash Nimare's kickass README guide](https://gist.github.com/akashnimare/7b065c12d9750578de8e705fb4771d2f)
- [Dan Bader's README template](https://github.com/dbader/readme-template)
- [Billie Thompson's README Template](https://gist.github.com/PurpleBooth/109311bb0361f32d87a2)
- [Awesome README Collection](https://github.com/matiassingers/awesome-readme)
- [Akash Nimare's README Guide](https://gist.github.com/akashnimare/7b065c12d9750578de8e705fb4771d2f)
- [Dan Bader's README Template](https://github.com/dbader/readme-template)

## Licensing
## License

This project is licensed under an Unlicense license. This license does not require
you to take the license with you to your project.
This project is licensed under the [Unlicense](https://unlicense.org/). You are free to use, modify, and distribute this template without any conditions.

[issues]:https://github.com/jehna/readme-best-practices/issues/new
[issues]: https://github.com/jehna/readme-best-practices/issues/new