-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- remove: templates/* - update: README.md - remove: testing content Resolves: #19 Resolves: #18 Resolves: #6 See also: #3
- Loading branch information
Daniel S
authored
Apr 11, 2019
1 parent
fefa367
commit e9ffa2e
Showing
8 changed files
with
8 additions
and
342 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
||
|
@@ -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 | ||
|
||
|
@@ -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) --> |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.