Skip to content

Move main README to Wiki #216

Open
Open

Description

@bartoszmajsak

I think README should be brief entry point to anyone who just come across our repository. It should simply describe what it is and how to run it.

Details such as how to contribute and related guidelines as well as build options could be moved to GitHub wiki.

If you think it is a good idea I can do this.

Activity

  1. arun-gupta commented on May 5, 2014

    @arun-gupta
    Contributor

    Yep, sounds like a great idea.

    Lets keep README simple.

  2. aslakknutsen commented on May 5, 2014

    @aslakknutsen
    Member

    Add a CONTRIBUTING file to root that points to wiki

    https://github.com/blog/1184-contributing-guidelines

  3. bartoszmajsak commented on May 5, 2014

    @bartoszmajsak
    ContributorAuthor

    Good point, thanks @aslakknutsen. Keen to create one? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions