Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add all READMEs #17

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# SciGuides
Yxhej marked this conversation as resolved.
Show resolved Hide resolved

Welcome to SciGuides, a repository made by FRC Team 1155 and 2265 to gather all of our experience and knowledge for public and internal use.
Yxhej marked this conversation as resolved.
Show resolved Hide resolved

## Usage
Yxhej marked this conversation as resolved.
Show resolved Hide resolved

SciGuides is project-based, containing guides and reference sheets aimed at guiding readers towards a high level of competency around FRC code.

It can be used as teaching material, robot code practice, or for referencing information and generational knowledge.

This repository additionally functions as the curriculum of our school's central robotics program.
Yxhej marked this conversation as resolved.
Show resolved Hide resolved

## Contributing & Updating

There are a few values we emphasize when writing SciGuides:

- Don't reinvent the wheel.
- Maintaining more than necessary, or redundant information, would be a waste of time, so we heavily reference existing documentation from vendors, libraries, and WPILib.
- Minimize what must be changed from year-to-year! There is no need to restate information with existing documentation past a simple sentence or past the purposes of introduction.

- Experiencing is the heart of learning.
- It is our firm belief that people learn best when actually **writing** and **seeing** code (not just text) on the screen. Code examples, code examples, code examples (and the occasional image and gif, too!)
- In the same vein, aim to be as concise and to-the-point as possible. Gigantic text walls are daunting and difficult to follow.

- Keep to typical standards of documentation.
- Please look over your grammar, punctuation, and spelling before submitting your PR for review. At worst, errors should not obstruct understanding.

- These guidelines are not immutable.
- Use your own discretion (or that of your fellow team members) to determine what is best for this repository to achieve its goals.
File renamed without changes.
3 changes: 3 additions & 0 deletions reference-sheets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Document Reference Sheets

This folder contains guides that introduce and summarize key topics and practices with links to official WPILib / vendor documentation for further, in-depth exploration.
Yxhej marked this conversation as resolved.
Show resolved Hide resolved