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

feat: Version 1.0.0 #20

Merged
merged 1 commit into from
Apr 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 8 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,27 @@ author: while-true-do.io
contact: [email protected]
license: BSD-3-Clause
-->

<!-- github shields -->
![](https://img.shields.io/github/tag/while-true-do/doc-library.svg)
![](https://img.shields.io/github/license/while-true-do/doc-library.svg?style=flat)
![](https://img.shields.io/github/issues/while-true-do/doc-library.svg?style=flat)
![](https://img.shields.io/github/issues-pr/while-true-do/doc-library.svg?style=flat)
<!-- travis testing shields -->
[![Build Status](https://travis-ci.org/while-true-do/doc-library.svg?branch=master)](https://travis-ci.org/while-true-do/doc-library)

# doc-library

A repository containing some documents and templates.
A repository containing static documents.

## Motivation

During the past years, while-true-do.io opened and closed some repositories. We
faced the situation, that maintaining Guidelines and other general purpose
documents was somewhat tedious. Keeping track of documents and templates should
be easy and centrally manageable.
documents was somewhat tedious. Keeping track of documents should be easy and
centrally manageable.

## Description

This repository keeps track of common documents and templates.
This repository keeps track of common documents.

### Documents

Expand All @@ -37,52 +37,24 @@ see updates in the doc-library.
- [Contribution Guideline](./docs/CONTRIBUTING.md)
- [Versioning](./docs/VERSIONING.md)

### Templates

Templates are meant as a Starting Point. You should adjust them to your needs
and liking.

- [.editorconfig](./templates/.editorconfig.j2)
- [.gitattributes](./templates/.gitattributes.j2)
- [.gitignore](./templates/.gitignore.j2)
- [.gitmessage](./templates/.gitmessage.j2)
- [LICENSE](./templates/LICENSE.j2)
- [kudos.txt](./templates/kudos.txt.j2)
- [README.md](./templates/README.md.j2)

## Requirements

None.

## Installation

Install from [Github](https://github.com/while-true-do/doc-library)

```
git clone https://github.com/while-true-do/doc-library.git
```

## Usage

1. Enable .gitmessage as commit template

```
# Only for the repository
git config commit.template .gitmessage
# Global for all repositories
git config --global commit.template .gitmessage
```

2. Copy and rename the files from ./templates to the desired destination
3. Edit the files properly (at least "{{ WTD_REPO_NAME }}" must be replaced)
4. Update all "TODO" Sections to your likings
Link to the documents, if needed.

## Testing

Most of the "generic" tests are located in the
[Test Library](https://github.com/while-true-do/test-library). Tests and
instructions for a single repository are located in the
[Test Directory](./tests).
This repository is not tested.

## Contribute

Expand All @@ -106,6 +78,3 @@ This work is licensed under a [BSD-3-Clause License](https://opensource.org/lice
- Mail [[email protected]](mailto:[email protected])
- IRC [freenode, #while-true-do](https://webchat.freenode.net/?channels=while-true-do)
- Telegram <https://t.me/while_true_do>


<!-- ./Footer (auto generated) -->
24 changes: 0 additions & 24 deletions templates/.editorconfig.j2

This file was deleted.

13 changes: 0 additions & 13 deletions templates/.gitattributes.j2

This file was deleted.

49 changes: 0 additions & 49 deletions templates/.gitignore.j2

This file was deleted.

65 changes: 0 additions & 65 deletions templates/.gitmessage.j2

This file was deleted.

29 changes: 0 additions & 29 deletions templates/LICENSE.j2

This file was deleted.

96 changes: 0 additions & 96 deletions templates/README.md.j2

This file was deleted.

Loading