A studyguide created in Bootcamp to help students study the things learned in bootcamp and beyond.
This Prework Study Guide was created for boot camp students who were going through the Prework. It contains notes on HTML, CSS, Git, and JavaScript.
N/A
To use this Prework Study Guide, you can review the notes in each section. For suggestions on what to study first, open the Chrome DevTools by pressing Command+Option+I (macOS) or Control+Shift+I (Windows). A console panel should open either below or to the side of the webpage in the browser. There you will see a list of topics we learned from the prework along with a suggestion on which topic to study first.
N/A
Please refer to the LICENSE in the repo.
This is a proper guide on how to write a README File. This should be the bare minimum in a project. I know you were expecting a Full on README file but I felt it was more important to put a working example instead. Afterall this is a Prework Study Guide. Everything below this is pure example for refererance to future work.
Provide a short description explaining the what, why, and how of your project. Use the following questions as a guide:
- What was your motivation?
- Why did you build this project? (Note: the answer is not "Because it was a homework assignment.")
- What problem does it solve?
- What did you learn?
If your README is long, add a table of contents to make it easy for users to find what they need.
What are the steps required to install your project? Provide a step-by-step description of how to get the development environment running.
Provide instructions and examples for use. Include screenshots as needed.
To add a screenshot, create an assets/images folder in your repository and upload your screenshot to it. Then, using the relative file path, add it to your README using the following syntax:
List your collaborators, if any, with links to their GitHub profiles.
If you used any third-party assets that require attribution, list the creators with links to their primary web presence in this section.
If you followed tutorials, include links to those here as well.
The last section of a high-quality README file is the license. This lets other developers know what they can and cannot do with your project. If you need help choosing a license, refer to https://choosealicense.com/.
🏆 The previous sections are the bare minimum, and your project will ultimately determine the content of this document. You might also want to consider adding the following sections.
Badges aren't necessary, but they demonstrate street cred. Badges let other developers know that you know what you're doing. Check out the badges hosted by shields.io. You may not understand what they all represent now, but you will in time.
If your project has a lot of features, list them here.
If you created an application or package and would like other developers to contribute to it, you can include guidelines for how to do so. The Contributor Covenant is an industry standard, but you can always write your own if you'd prefer.
Go the extra mile and write tests for your application. Then provide examples on how to run them here. Now fill in the details as much as you can, referring to the following tips as you go:
Remember that # in markdown is the top-level header, which is typically the title of the page. You can create your own title. For our example purposes, we will use “Prework Study Guide Webpage”.
Next, ## in markdown is a subheading. We have several subheadings in this README.
For ## Description, write a short description of the Prework Study Guide Webpage. Use the guiding questions to help you.
We don't have a long README, so you can delete the ## Table of Contents section.
For ## Installation, we don’t have any steps to take to install anything for our webpage, so write “N/A” for this section.
For ## Usage, write a short paragraph about how this Prework Study Guide can be used. For example, you can write about how each section contains notes about a certain topic, like HTML, CSS, JavaScript, Git. And if we open the DevTools console, we can see the JavaScript running. It will list the topics we learned from prework and choose one topic for us to study first. For now, we don't need to add an image, so you can delete that part.
For ## Credits, we didn’t collaborate with others nor did we use any third-party assets or tutorials, so we can write “N/A”.
For ## License, keep the MIT license that we chose when we first created the repository.
The rest of the sections don’t apply to us, but feel free to take a look.