Skip to content

Update readme with current build and release instructions #29

@st3phhays

Description

@st3phhays

Checklist

  • I have verified this is the correct repository for opening this issue.
  • I have verified no other issues exist related to my request.

Is Your Feature Request Related To A Problem? Please describe.

The readme in this repository is confusing and hasn't been changed since the repo was forked. It doesn't give a good resource on how to build the repository.

Describe The Solution. Why is it needed?

The readme needs overhauled. Current build instructions are mostly here: https://support.zendesk.com/hc/en-us/articles/4408822095642-Previewing-theme-changes-locally

Then, with the addition of choco-theme, it is to note that yarn and yarn choco-theme is to be ran before the above instructions.

Additional Context

No response

Related Issues

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    4 - DoneCode has been added to the repository, and has been reviewed by a team member.EnhancementIssues that introduce new functionality to the project, or enhances/updates existing functionality.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions