Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.66 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.66 KB
Raw

A template for Spherity proposals

This repository establishes a base for Spherity proposals and drafts using respec as a foundation.

This repo includes a number of defaults for the respec template. See respecConfig for the exact configuration.

🔋 Getting started

  1. Click on 'Use this template' in the github interface
  2. Create the new templated repository in your user namespace or Spherity namespace
  3. Open index.html and replace the following variables with your content
    1. Spec Information:
      • SPEC_TITLE
      • SPEC_SUBTITLE
    2. Author Information:
      • YOUR_NAME
      • YOUR_WEBSITE
      • YOUR_COMPANY
      • YOUR_COMPANY_WEBSITE
    3. Repository Information:
      • REPO_LINK
      • PAGE_URL
  4. Open the index.html file in your local browser to preview your draft
  5. Once you are ready, push your changes to your repo.

✍️ Working with this template

Please see the respec documentation for an in-depth explanation of all possible options for writing your proposal. However, a good base can be established by expanding your abstraction definition and including new sections for your proposal. Some examples are already included in index.html.

📖 Github Pages

When you update the main branch of your proposal repository, the resulting content will automatically published to a github page that you can share. Using the default configuration your page should be accessible at:

https://<user>.github.io/<repository>

To activate this feature navigate to Settings > Pages and define an action.