Write project documentation - Githubissues

co-stig / opencompare

Open Compare is a generic open-source compare tool

MIT License

2 stars 0 forks source link

Write project documentation #6

Open co-stig opened 9 years ago

co-stig commented 9 years ago

Currently the project doesn't feature any proper documentation. The following is required (to be split into separate issues):

Javadocs
Markdown documentation for Github:
- What it is and how it works (welcome page)
- Architecture, key concepts, modules and classes
- How to build the project
- How to contribute
- Plugin writing techniques
- Tutorials for writing plugins
- FAQ
User-friendly site:
- Just a static web site (something like Joomla or WordPress)
- Register domain name (opencompare.org is available)
- Screenshots
- Downloads
- Video tutorial
- About + links to Github resources

co-stig commented 9 years ago

Created a preview for the homepage: http://co-stig.github.io/opencompare