This repository has been archived by the owner on Jun 11, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#54 [doc] Write new concept for the ReadMe structure.
- Loading branch information
Showing
2 changed files
with
55 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,54 @@ | ||
-------------------------------------------------------------------------------- | ||
CONCEPT ReadMe v0.5.0-PRERELEASE | ||
-------------------------------------------------------------------------------- | ||
DESCRIPTION | ||
In this concept I want to write the 'actual' and 'future' condition from the | ||
topic 'ReadMe' in the application 'ABC-List'. | ||
|
||
-------------------------------------------------------------------------------- | ||
ACTUAL CONDITION | ||
Momentary following chapters exists in the ReadMe: | ||
- Main title | ||
- Application name. | ||
- Contains the 'badges' from img.shield.io. | ||
- Intention | ||
- Short description for what the application is. | ||
- Hint which version momentary is actual. | ||
- Different screenshots. | ||
- Content | ||
- Quick links to the different topics from this ReadMe. | ||
- Download | ||
- Infos how to download and start the application. | ||
- Requirements | ||
- Requirements to run this application. | ||
- License | ||
- Info to the license from this project. | ||
- Autor | ||
- The project 'ABC-List' is maintained by me, Peter Rogge. See Contact. | ||
- Contact | ||
- You can reach me unter <email-adress> | ||
|
||
-------------------------------------------------------------------------------- | ||
FUTURE CONDITION | ||
- [v] Main title | ||
- [ ] Intention | ||
- [ ] Remove the version info. | ||
- [ ] Only one screenshot. | ||
- [ ] Content | ||
- Quick links to the different topics from this ReadMe. | ||
- [ ] Overview features. | ||
- [ ] Screenshoots | ||
- [ ] User help | ||
- [ ] User help description. | ||
- [ ] Content User help | ||
- [ ] The user help is generated with the GitHub wiki system. | ||
- [ ] Testdata generation | ||
- [ ] Download | ||
- [ ] Restructure the infos. | ||
- [ ] Requirements | ||
- [ ] Restructure the infos. | ||
- [v] License | ||
- [v] Autor | ||
- [v] Contact | ||
|
||
-------------------------------------------------------------------------------- |
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