mirror of
https://github.com/We-Dont-Byte/Mind_Reader.git
synced 2024-11-14 19:25:59 +00:00
Updated README
Updated the README with instructions on how to setup the line highlighter for the first time, added a table for the line highlighter options, added our team's contact information
This commit is contained in:
tel0065
GitHub
parent
96b814a0de
commit
faba55822c
88
README.md
88
README.md
@ -130,10 +130,98 @@ directions above.
|
||||
See the Visual Studio Code [getting started](https://code.visualstudio.com/api/get-started/your-first-extension)
|
||||
API page if you need more help.
|
||||
|
||||
# First Time Setting Up the Line Highlighter Feature
|
||||
Before running Mind Reader for the first time it is recommended to add the following code block to your `settings.json` file
|
||||
|
||||
### Opening Settings.json
|
||||
1. Launch VS Code
|
||||
2. Open the `Command Palette` by pressing **Ctrl + Shift + P** (Windows) / **Cmd + Shift + P** (Mac)
|
||||
3. The Command Palette should appear at the top of your screen ready for you to type
|
||||
4. Type `settings` and highlight the option that appears saying `Preferences: Open Settings (JSON)` then select it
|
||||
5. Your `settings.json` window should appear, scroll to the bottom and make sure the last item has a `,` before the closing curly bracket `}`
|
||||
6. Paste the following code block after the last comma `,`, but before the closing curly bracket `}`:
|
||||
```
|
||||
"mind-reader.lineHighlighter.isEnabled" : true,
|
||||
"mind-reader.lineHighlighter.multiLineIsEnabled" : false,
|
||||
|
||||
"mind-reader.lineHighlighter.backgroundColor" : "#232C5C",
|
||||
|
||||
"mind-reader.lineHighlighter.outlineColor" : "#4866FE",
|
||||
"mind-reader.lineHighlighter.outlineWidth" : "1px",
|
||||
"mind-reader.lineHighlighter.outlineStyle" : "solid",
|
||||
|
||||
"mind-reader.lineHighlighter.borderColorTop" : "#FFFFFF",
|
||||
"mind-reader.lineHighlighter.borderColorRight" : "#FFFFFF",
|
||||
"mind-reader.lineHighlighter.borderColorBottom" : "#FFFFFF",
|
||||
"mind-reader.lineHighlighter.borderColorLeft" : "#FFFFFF",
|
||||
|
||||
"mind-reader.lineHighlighter.borderWidthTop" : "1px",
|
||||
"mind-reader.lineHighlighter.borderWidthRight" : "16px",
|
||||
"mind-reader.lineHighlighter.borderWidthBottom" : "1px",
|
||||
"mind-reader.lineHighlighter.borderWidthLeft" : "1px",
|
||||
|
||||
"mind-reader.lineHighlighter.borderStyleTop" : "solid",
|
||||
"mind-reader.lineHighlighter.borderStyleRight" : "solid",
|
||||
"mind-reader.lineHighlighter.borderStyleBottom" : "solid",
|
||||
"mind-reader.lineHighlighter.borderStyleLeft" : "solid",
|
||||
|
||||
"mind-reader.lineHighlighter.fontStyle" : "normal",
|
||||
"mind-reader.lineHighlighter.fontWeight" : "bolder",
|
||||
"mind-reader.lineHighlighter.textDecoration" : "none",
|
||||
"mind-reader.lineHighlighter.textColor" : "#FFFFFF",
|
||||
```
|
||||
The values are set to the default values and can be changed here manually, or through the settings window (File -> Preferences -> Settings -> Mind Reader -> Line Highlighter).
|
||||
Changes made directly in the settings.json will take effect automatically; however, if you change them in the settings window then after you input your new values VS Code must be closed and reopened for the changes to take effect.
|
||||
|
||||
After adding the code block, the `settings.json` file should look similar to this:
|
||||
|
||||
<p align="center">
|
||||
<img width="35%" height="35%" alt="line highlighter first time setup" src="media/line_highlighter_setup.PNG"></img>
|
||||
</p>
|
||||
|
||||
7. Save and close `settings.json`
|
||||
|
||||
### Line Highlighter Settings Table
|
||||
| **Item** | **Description** | **Accepted Value** | **Default Values** |
|
||||
|------------------------|-------------------------------------------------------|------------------------------------------------------------------------------|--------------------|
|
||||
| **isEnabled** | Enable/Disables the line highlighter | boolean | true |
|
||||
| **multiLineIsEnabled** | Highlight when clicking and dragging to select lines | boolean | false |
|
||||
| **backgroundColor** | Changes the background color of the highlight | HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" | "#232C5C" |
|
||||
| **outlineColor** | Outline Color | HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" | "#4866FE" |
|
||||
| **outlineWidth** | Outline Width | "medium", "thin", "thick", length (integer + string unit), or "none" | "1px" |
|
||||
| **outlineStyle** | Outline Style | none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset | "solid" |
|
||||
| **borderColorTop** | Top Border Color | HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" | "#FFFFFF" |
|
||||
| **borderColorRight** | Right Border Color | HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" | "#FFFFFF" |
|
||||
| **borderColorBottom** | Bottom Border Color | HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" | "#FFFFFF" |
|
||||
| **borderColorLeft** | Left Border Color | HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" | "#FFFFFF" |
|
||||
| **borderWidthTop** | Top Border Width | "medium", "thin", "thick", length (integer + string unit), or "none" | "1px" |
|
||||
| **borderWidthRight** | Right Border Width | "medium", "thin", "thick", length (integer + string unit), or "none" | "16px" |
|
||||
| **borderWidthBottom** | Bottom Border Width | "medium", "thin", "thick", length (integer + string unit), or "none" | "1px" |
|
||||
| **borderWidthLeft** | Left Border Width | "medium", "thin", "thick", length (integer + string unit), or "none" | "1px" |
|
||||
| **borderStyleTop** | Top Border Style | none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset | "solid" |
|
||||
| **borderStyleRight** | Right Border Style | none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset | "solid" |
|
||||
| **borderStyleBottom** | Bottom Border Style | none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset | "solid" |
|
||||
| **borderStyleLeft** | Left Border Style | none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset | "solid" |
|
||||
| **fontStyle** | Styling to the font contained within the highlight | "normal", "italic", "oblique", or "none" | "normal" |
|
||||
| **fontWeight** | Weight of the font contained within the highlight | "normal", "bold", "bolder", "lighter", string based number, "none" | "bolder" |
|
||||
| **textDecoration** | Decoration of the font contained within the highlight | See: https://www.w3schools.com/cssref/pr_text_text-decoration.asp | "none" |
|
||||
| **textColor** | Color of the font contained within the highlight | HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" | "#FFFFFF" |
|
||||
|
||||
|
||||
# Contact Information
|
||||
|
||||
### Single Semester Snobs
|
||||
#### Fall 2021 Semester
|
||||
- Jake Grossman: [\<JacobGrossman2@my.unt.edu\>](mailto:JacobGrossman2@my.unt.edu)
|
||||
- Cal Wooten: [\<calwooten@my.unt.edu\>](mailto:calwooten@my.unt.edu)
|
||||
- Josiah Moses: [\<josiahmoses@my.unt.edu\>](mailto:josiahmoses@my.unt.edu)
|
||||
- Sophia Drewfs: [\<sophiadrewfs@my.unt.edu\>](mailto:sophiadrewfs@my.unt.edu)
|
||||
- Mason Bone: [\<masonbone@my.unt.edu\>](mailto:masonbone@my.unt.edu)
|
||||
|
||||
### We Don't Byte
|
||||
#### Spring 2022 Semester
|
||||
- John Breaux: [\<JohnBreaux@my.unt.edu\>](mailto:JohnBreaux@my.unt.edu)
|
||||
- Thomas Lane: [\<ThomasLane2@my.unt.edu\>](mailto:ThomasLane2@my.unt.edu)
|
||||
- Kendrick Johnson: [\<KendrickJohnson@my.unt.edu\>](mailto:KendrickJohnson@my.unt.edu)
|
||||
- Ryan Tolbert: [\<RyanTolbert@my.unt.edu\>](mailto:RyanTolbert@my.unt.edu)
|
||||
- Pedro Alvarez: [\<PedroAlvarez3@my.unt.edu\>](mailto:PedroAlvarez3@my.unt.edu)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user