From ae373496e44b0a7e37f7a7a36a6639cc5a4af8db Mon Sep 17 00:00:00 2001 From: Jeff Martin Date: Tue, 8 Jan 2019 08:32:07 -0800 Subject: [PATCH] Updated readme files and site home page resources. --- docs/index.html | 27 +++++++++++++++++++++++++-- docs/readme.md | 9 ++++++--- readme.md | 12 ++++++------ 3 files changed, 37 insertions(+), 11 deletions(-) diff --git a/docs/index.html b/docs/index.html index 2d95b266..70cbd5fa 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,10 +3,33 @@

Propeller 2 Developer Site

P2 Pinout

Resources

+

Documentation

+

Emulation Source

+ +

Software

+ +

Discussion

+ +

Other

+ \ No newline at end of file diff --git a/docs/readme.md b/docs/readme.md index fa655df7..84d4999f 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -1,5 +1,8 @@ # Docs Folder -This folder contains the source for the entire https://propeller.parallax.com website. The site is hosted via GitHub Pages and the folder name -'docs' is required by the GitHub Pages service as the site's root folder in the repository. +This folder contains the source for the entire https://propeller.parallax.com website. It is expected to grow in size (files/folders) as more content is created and shared. -The site is generated and served by Jekyll. +The site is hosted via GitHub Pages, generated and served by Jekyll. The parent folder named 'docs' is required by the GitHub Pages service as the website's root folder in the repository. + +## Files and Folders +* ```index.html``` - this file is the site's home page +* ```/assets``` - Various site resources (such as graphic files) are stored here diff --git a/readme.md b/readme.md index 9997b968..c8369918 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,9 @@ # Propeller 2 Repository -This repository serves as a source of information and source code for the Propeller Community as the Propeller 2 is tested and further developed. Want to contribute? [Follow these steps.](https://github.com/parallaxinc/propeller/wiki/Contributing) +This repository serves as a source of information and source code for the Propeller Community as the Propeller 2 is tested and further developed. + +## Want to contribute? +Parallax welcomes Propeller Community members to contribute to this repository. Don't allow great resources to remain buried in the forums - share them here in a version-controlled, centralized place for new and existing users to enjoy. Have you created example Propeller 2 code you want to share? Do you know of (or have created) Propeller 2 tools, tips, etc.? Please [follow these steps](https://github.com/parallaxinc/propeller/wiki/Contributing) to include them here for all to see. ## Resources -- A simple [Propeller Website](https://propeller.parallax.com) is driven by content in the /docs subfolder. -- The latest [Propeller 2 Documentation](https://docs.google.com/document/d/1UnelI6fpVPHFISQ9vpLzOVa8oUghxpI6UpkXVsYgBEQ/edit?usp=sharing) is contained in a Google Doc with community commenting enabled. -- [Parallax Propeller 2 Instructions v32](https://docs.google.com/spreadsheets/d/1usUcCCQVp3liAqENX9rvX-XVqJomMREhKYExM_taG0A/edit?usp=sharing) is contained in a Google Spreadsheet. -- [Prop2 FPGA File](http://forums.parallax.com/discussion/162298/prop2-fpga-files-updated-2-june-2018-final-version-32i) information is on the forum. -- [Propeller 2 Forum](http://forums.parallax.com/categories/propeller-2-multicore-microcontroller) discussions. +- Visit the [Propeller Website](https://propeller.parallax.com) (driven by content in this repository's /docs subfolder) for a collection of resources. +- See the [/examples](https://github.com/parallaxinc/propeller/tree/master/examples) subfolder for code examples.