Skip to content
This repository has been archived by the owner on Jun 11, 2023. It is now read-only.

Commit

Permalink
#54 [doc] Write new concept for the ReadMe structure.
Browse files Browse the repository at this point in the history
  • Loading branch information
Naoghuman committed Dec 1, 2018
1 parent e3ee8c9 commit a5a83f1
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 0 deletions.
54 changes: 54 additions & 0 deletions concept/Concept_ReadMe_v0.5.0-PRERELEASE_2018-12-01.txt
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

--------------------------------------------------------------------------------
1 change: 1 addition & 0 deletions release/Release_v0.5.0-PRERELEASE_2018-MM-dd_HH-mm.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ topic through `key terms`.
#58 [doc] Write new concept for the topic 'i18n' in the application.
#57 [doc] Write new concept for the topic 'sql' in the application.
#56 [doc] Write new concept for the topic 'json' in the application.
#54 [doc] Write new concept for the ReadMe structure.
#47 [doc] Update the application description.


Expand Down

0 comments on commit a5a83f1

Please sign in to comment.