Skip to content
This repository has been archived by the owner on Dec 19, 2018. It is now read-only.

Write the documentation #2

Open
ajsb85 opened this issue Jun 7, 2017 · 0 comments
Open

Write the documentation #2

ajsb85 opened this issue Jun 7, 2017 · 0 comments
Assignees
@ajsb85 @rafaelje @Naylin15
Labels
documentation hacktoberfest month-long celebration of open source software
Milestone
1.0

Comments

@ajsb85
Copy link
Contributor

ajsb85 commented Jun 7, 2017

Create the wiki pages for these topics:

  • Home
  • How to install
  • How to use
  • How it works
  • How to build
  • Code documentation

https://github.com/flyve-mdm/flyve-mdm-ios-inventory/wiki

Note: The code documentation can be generated in markdown from the comments of the code.
(Example: Javadoc to Markdown)

About GitHub Wikis
https://help.github.com/articles/about-github-wikis/

Excellent documentation helps others use and extend the project.
@ajsb85 ajsb85 added this to the v2.0.0 milestone Jun 7, 2017
@ajsb85 ajsb85 modified the milestone: 1.0 Aug 25, 2017
@ajsb85 ajsb85 added the hacktoberfest month-long celebration of open source software label Oct 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@ajsb85 ajsb85

@rafaelje rafaelje

@Naylin15 Naylin15

Labels
documentation hacktoberfest month-long celebration of open source software
Projects
None yet
Milestone
1.0
Development

No branches or pull requests
4 participants
@ajsb85 @bootbeep @rafaelje @Naylin15