Skip to content
This repository was archived by the owner on Oct 24, 2024. It is now read-only.

Commit b97519f

Browse files
committed
Rework README a little bit
1) Use real text + placeholders for a couple of the simple sections. 2) Try to make it more obvious which parts need to be rewritten. This time around, I tried putting the explanations about the template in Markdown blockquotes, to distinguish it from literal text that can be left in the finished file.
1 parent d74e69f commit b97519f

File tree

1 file changed

+15
-23
lines changed

1 file changed

+15
-23
lines changed

README.md

Lines changed: 15 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -21,48 +21,40 @@
2121

2222
## Introduction
2323

24-
This README file is in Markdown format, and is meant to provide a template for README files as well an illustration of what the README file can be expected to look like. For a software project, this [Introduction](#introduction) section – which you are presently reading – should provide background for the project, a brief explanation of what the project is about, and optionally, pointers to resources that can help orient readers. Ideally, this section should be short.
24+
> _This README file is in Markdown format, and is meant to provide a template for README files as well an illustration of what the README file can be expected to look like. For a software project, this [Introduction](#introduction) section – which you are presently reading – should provide background for the project, a brief explanation of what the project is about, and optionally, pointers to resources that can help orient readers. Ideally, this section should be short._
2525
2626

2727
## Installation
2828

29-
Begin this section by mentioning any prerequisites that may be important for users to have before they can use your software. Examples include hardware and operating system requirements.
30-
31-
Next, provide step-by-step instructions for installing the software, preferably with command examples that can be copy-pasted by readers into their software environments. For example:
32-
33-
```bash
34-
a command-line command here
35-
```
36-
37-
Sometimes, subsections may be needed for different operating systems or particularly complicated installations.
29+
> _Begin this section by mentioning any prerequisites that may be important for users to have before they can use your software. Examples include hardware and operating system requirements._
30+
>
31+
> _Next, provide step-by-step instructions for installing the software, preferably with command examples that can be copy-pasted by readers into their software environments._
32+
>
33+
> _Sometimes, subsections may be needed for different operating systems or particularly complicated installations._
3834
3935

4036
## Usage
4137

42-
This [Usage](#usage) section would explain more about how to run the software, what kind of behavior to expect, and so on.
43-
44-
### _Basic operation_
45-
46-
Begin with the simplest possible example of how to use your software. Provide example command lines and/or screen images, as appropriate, to help readers understand how the software is expected to be used. Many readers are likely to look for command lines they can copy-paste directly from your explanations, so it's best to keep that in mind as you write examples.
47-
48-
### _Additional options_
49-
50-
Some projects need to communicate additional information to users and can benefit from additional sections in the README file. It's difficult to give specific instructions – a lot depends on your software, your intended audience, etc. Use your judgment and ask for feedback from users or colleagues to help figure out what else is worth explaining.
38+
> _This [Usage](#usage) section would explain more about how to run the software, what kind of behavior to expect, and so on._
39+
>
40+
> _Begin with the simplest possible example of how to use your software. Provide example command lines and/or screen images, as appropriate, to help readers understand how the software is expected to be used. Many readers are likely to look for command lines they can copy-paste directly from your explanations, so it's best to keep that in mind as you write examples._
41+
>
42+
> _Some projects need to communicate additional information to users and can benefit from additional sections in the README file. It's difficult to give specific instructions – a lot depends on your software, your intended audience, etc. Use your judgment and ask for feedback from users or colleagues to help figure out what else is worth explaining._
5143
5244

5345
## Known issues and limitations
5446

55-
In this section, summarize any notable issues and/or limitations of your software. If none are known yet, this section can be omitted (and don't forget to remove the corresponding entry in the [Table of Contents](#table-of-contents) too); alternatively, you can leave this section in and write something along the lines of "none are known at this time".
47+
> _In this section, summarize any notable issues and/or limitations of your software. If none are known yet, this section can be omitted (and don't forget to remove the corresponding entry in the [Table of Contents](#table-of-contents) too); alternatively, you can leave this section in and write something along the lines of "none are known at this time"._
5648
5749

5850
## Getting help
5951

60-
Inform readers of how they can contact you, or at least how they can report problems they may encounter. This may simply be a request to use the issue tracker on your repository, but many projects have associated chat or mailing lists, and this section is a good place to mention those.
52+
If you find an issue, please submit it in [the GitHub issue tracker](https://github.com/caltechlibrary/%PROJECT_NAME%/issues) for this repository.
6153

6254

6355
## Contributing
6456

65-
This section is optional; if your repository is for a project that accepts open-source contributions, then this section is where you can mention how people can offer contributions, and point them to your guidelines for contributing. (If you delete this section, don't forget to remove the corresponding entry in the [Table of Contents](#table-of-contents) too.)
57+
Your help and participation in enhancing %PROJECT_NAME% is welcome! Please visit the [guidelines for contributing](CONTRIBUTING.md) for some tips on getting started.
6658

6759

6860
## License
@@ -72,7 +64,7 @@ Software produced by the Caltech Library is Copyright © %CREATION_YEAR% Califor
7264

7365
## Authors and history
7466

75-
In this section, list the authors and contributors to your software project. Adding additional notes here about the history of the project can make it more interesting and compelling. This is also a place where you can acknowledge other contributions to the work and the use of other people's software or tools.
67+
> _In this section, list the authors and contributors to your software project. Adding additional notes here about the history of the project can make it more interesting and compelling. This is also a place where you can acknowledge other contributions to the work and the use of other people's software or tools._
7668
7769

7870
## Acknowledgments

0 commit comments

Comments
 (0)