Skip to content

Commit

Permalink
Updated readme with contributing instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
theianjohnson committed Sep 9, 2019
1 parent 8077138 commit 926944c
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,18 @@ https://medium.com/skilljar-engineering/the-quickest-dirtiest-automatic-est-vue-
* [Done, not yet published] Update documentation table of contents to be sticky
* [Done, not yet published] Update CSS override classes to be individual properties rather than one all-or-nothing overridable object
* [Done, not yet published] Add documentation ~URL~ description field for component meta
* [Done, not yet published] Add description field for prop meta
* [Done, not yet published] Add description field for prop meta

# Contributing
PRs totally accepted 👍

To run this project locally you'll need a few global packages installed
* `npm install -g @vue/cli @vue/cli-global-service`

Then get to the `example` directory
* `cd /your-repo-location/vue-documenter/example`

And run it!
* `npm run serve`

This will build the `/your-repo-location/vue-documenter/src/VueDocumenter.vue` and copy the compiled file to the `/your-repo-location/vue-documenter/example/dist/` directory where it'll be referenced correctly by the example `App.vue` entrypoint

0 comments on commit 926944c

Please sign in to comment.