Skip to content
This repository has been archived by the owner on Oct 25, 2021. It is now read-only.

[general] Improve docs, showcase and contributing section #160

Open
realvictorprm opened this issue Apr 22, 2017 · 2 comments
Open

[general] Improve docs, showcase and contributing section #160

realvictorprm opened this issue Apr 22, 2017 · 2 comments
Assignees
Projects
Milestone

Comments

@realvictorprm
Copy link
Contributor

Currently the github page of Embeddinator is lacking detailed information about how it works, where it's useful, how to contribute etc. I consider this as very important.

My suggestions is following:
Start with adding a wiki which describes in more detail how to use it, add some examples both to the repository and the wiki and at least at a contributing.md .

@VincentDondain
Copy link
Contributor

+1 for the wiki in general, as a way to give an overview of the whole project, explain the branches, link to builds and detail how to contribute.

Let us also keep in mind that we might want to avoid wiki pages for some files (like getting started in #223 for instance for instance) as we'll have to push them to our documentation website.

@chamons chamons added this to Infrastructure in ObjC Mar 19, 2018
chamons added a commit to chamons/Embeddinator-4000 that referenced this issue Apr 6, 2018
@chamons chamons self-assigned this Apr 9, 2018
@chamons
Copy link
Contributor

chamons commented Apr 9, 2018

Ok #646 has starting versions of everything mentioned here except showcase / more samples. These should likely wait until we figure out the msbuild story, as that will change them pretty dramatically.

chamons added a commit that referenced this issue Apr 10, 2018
- #160
- Contributing guide "borrowed" from xamarin-macios
@rolfbjarne rolfbjarne added this to the Future milestone Sep 3, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
ObjC
Infrastructure
Development

No branches or pull requests

4 participants