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

Updating README to mirror documentation for NEARStudio #130

Open
ckshei opened this issue Jun 12, 2019 · 1 comment
Open

Updating README to mirror documentation for NEARStudio #130

ckshei opened this issue Jun 12, 2019 · 1 comment

Comments

@ckshei
Copy link

ckshei commented Jun 12, 2019

I suggest we update the readme to mirror the documentation found here: https://docs.nearprotocol.com/quick-start/near-studio-ide-intro

Most people aren't going to want to run NEARStudio locally unless they're looking to make a contribution, so we should move the run locally instructions to a separate README or to a contributors guide or something.

@ckshei ckshei changed the title README suggestion: Updating README to mirror documentation for NEARStudio Jun 12, 2019
@vgrichina
Copy link
Contributor

I think README should include these docs vs just mirroring, so that on top there are user-oriented docs and on the bottom it's stuff for contributors, credits, etc

BTW, it's also possible to automate snippet extraction. E.g. there is such script in package.json, but for now only used for 1 of templates.

    "templates:build-template-docs": "mdinject -w --root=./templates/. --docsroot=./templates/. --sourceext=\".ts|.js|.html\" --targetext=\".md\"",

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants