Skip to content

Commit

Permalink
Switch to using ATX heading syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
mhucka committed Oct 14, 2021
1 parent fafd353 commit 0f4607f
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 26 deletions.
6 changes: 2 additions & 4 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Change log for REPOSITORY
=========================
# Change log for REPOSITORY

Version 0.0.0
-------------
## Version 0.0.0

* Write about a change here
* Write about another change here
Expand Down
33 changes: 11 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
Template for software repositories by the Caltech Library
=====================================================
# Template for software repositories by the Caltech Library

This is a template README file for software repositories. This first paragraph of the README should summarize your software in a concise fashion, preferably using no more than one or two sentences.

Expand All @@ -8,8 +7,7 @@ This is a template README file for software repositories. This first paragraph
[![DOI](https://data.caltech.edu/badge/201106666.svg)](https://data.caltech.edu/badge/latestdoi/201106666)


Table of contents
-----------------
## Table of contents

* [Introduction](#introduction)
* [Installation](#installation)
Expand All @@ -22,16 +20,14 @@ Table of contents
* [Acknowledgments](#authors-and-acknowledgments)


Introduction
------------
## Introduction

This repository is a GitHub template repository for creating software project repositories at the Caltech Library. The [associated wiki page](https://github.com/caltechlibrary/template/wiki/Using-this-template-repo) explains how to use the template repository.

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.


Installation
------------
## Installation

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.

Expand All @@ -44,8 +40,7 @@ a command-line command here
Sometimes, subsections may be needed for different operating systems or particularly complicated installations.


Usage
-----
## Usage

This [Usage](#usage) section would explain more about how to run the software, what kind of behavior to expect, and so on.

Expand All @@ -58,38 +53,32 @@ Begin with the simplest possible example of how to use your software. Provide e
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.


Known issues and limitations
----------------------------
## Known issues and limitations

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".


Getting help
------------
## Getting help

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.


Contributing
------------
## Contributing

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.)


License
-------
## License

Software produced by the Caltech Library is Copyright © 2021 California Institute of Technology. This software is freely distributed under a BSD/MIT type license. Please see the [LICENSE](LICENSE) file for more information.


Authors and history
---------------------------
## Authors and history

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.


Acknowledgments
---------------
## Acknowledgments

This work was funded by the California Institute of Technology Library.

Expand Down

0 comments on commit 0f4607f

Please sign in to comment.