Skip to content

Commit

Permalink
fix readme and fonts
Browse files Browse the repository at this point in the history
  • Loading branch information
tytremblay committed Dec 13, 2024
1 parent 3d4d678 commit 4a9a97f
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 8 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# NOTE

We changed to github pages. Please use https://frc2713.github.io/QRScout/ until we redirect http://scout.redhawkrobotics.org

# QRScout

A QR Code-based scouting system for FRC

## Getting started
Expand All @@ -13,21 +15,22 @@ QRScout takes in form data inputed durring a FRC match about the robots playing
## Using QRScout

When you visit QRScout, you're shown a screen that looks something like
![The QRScout homepage](./QRScout_home.png)
![The QRScout homepage](src/assets/images/QRScout_home.png)
At the top, and taking up most of the page, are form fields. These are the input for the data that will later be made into a QRCode.

Some of these fields are required, and others aren't. QRScout will refuse to let you submit the form until all of the required fields are filled out.

![The bottom of the QRScout homepage](./QRScout_bottom.png)
![The bottom of the QRScout homepage](src/assets/images/QRScout_bottom.png)
Down at the bottom of the page, there is the Commit, Reset Form, and Settings buttons. The Commit button will generate a QR code of the form data that you filled out above, and display this onscreen to be scanned, alongside the text that is encoded in the QR code. The Reset Form button resets most of the form fields, so that it can be used again without havng to reload the page. It does not reset the Prematch column, as most of this data can be reused from match to match.

> ![NOTE]
> The line delimiter in the text alongside the QRCode is always a pipe, regardless of what it set to. In the QRCode, however, it will be what you have set it to.
The Settings button brings up the Settings menu at the bottom of your screen:
![The QRScout settings menu](QRScout_settings.png)
![The QRScout settings menu](src/assets/images/QRScout_settings.png)

This has a number of buttons on it:

- Copy Column Names: Copies the names of the columns to your clipboard
- Edit Config: Edit the config.json file
- Download Config: Download the config.json file
Expand All @@ -47,7 +50,7 @@ The basic structure of the config.json file is as follows:
Root:
$schema: A refrence to the schema used by the config.json file. This shouldn't be changed from the default "../schema.json".
title: The title of the page. This is what appears in the tab bar.
page_title: The title that appears at the top of the QRScout page.
page_title: The title that appears at the top of the QRScout page.
delimiter: The line delimiter used by the QR code
sections: An array of sections/columns that hold and organize form inputs

Expand All @@ -64,10 +67,12 @@ code: camelCase string with a unique name indicaing what this field is.
disabled: Boolean indicating if this field is disabled. If it is, things cannot be inputted into it. This and the requied value are mutually exclusive if you want people to be able to submit this form.
preserveDataOnReset: If the data in this field is preserved when the Reset Form button is pressed.
choices: An object containng numbered keys mapping to values that this can hold. For example:

```json
"choices": {
"1": "First option",
"2": "Second option"
}
```
defaultValue: The default value of this field.

defaultValue: The default value of this field.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions src/index.css
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ body {

@font-face {
font-family: 'SF Sports Night';
src: url('./fonts/SF Sports Night.ttf') format('truetype');
src: url('./assets/fonts/SF Sports Night.ttf') format('truetype');
font-weight: normal;
font-style: normal;
}

@font-face {
font-family: 'SF Sports Night NS';
src: url('./fonts/SF Sports Night NS.ttf') format('truetype');
src: url('./assets/fonts/SF Sports Night NS.ttf') format('truetype');
font-weight: normal;
font-style: normal;
}
Expand Down
2 changes: 1 addition & 1 deletion vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ export default defineConfig({
'@': path.resolve(__dirname, './src'),
},
},
assetsInclude: ['fonts/*'],
assetsInclude: ['assets/**/*'],
});

0 comments on commit 4a9a97f

Please sign in to comment.