Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sbcd90/xcs224n-a5
https://github.com/sbcd90/xcs224n-a5
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/sbcd90/xcs224n-a5
- Owner: sbcd90
- Created: 2022-12-06T21:27:45.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-20T08:29:15.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T18:21:13.897Z (7 months ago)
- Language: Python
- Size: 120 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# XCS224N Revisions
Repository contents for the previous cohort is in the following branches.
- `Rev_XCS224N_Sept2019-Mar2021` branch: cohort from Sept. 2019 to March 2021
# XCS Student Code Repository
This repository contains all code for your assignment!
The build tools in this repo can be used to compile a LaTeX submission.
# What should I submit?
Take a look at the problem set PDF:
- If it contains any questions requiring written responses, a **written (or
typeset) PDF document** submission is required (typeset instructions below).
- If contains any questions requiring coding responses, **assignment5_submission.zip** must be uploaded and submitted to the autograder.
instructions below). See the A5.pdf file for how to prepare the file.
- Many of our problem sets will require both written (or typeset) AND coding submissions. Good luck!
## How to create a typeset submission using LaTeX
You are welcome to typeset your submission in any legible format (including
handwritten). For those who are trying LaTeX for the first time, consider using
the following build process (we've tried to streamline it as much as possible
for you!). All instructions that follow are for our build process, which will
require a working installation of [TeX Live](https://www.tug.org/texlive/) (This
website has installation instructions for Windows, Linux, and Mac). Most linux
distributions come pre-loaded with this. Mac users can download and install it
from [mactex](https://tug.org/mactex/)
All LaTeX files are in the `tex/` subdirectory. Your question responses will be
typed into the file `tex/submission.tex`. We recommend attempting to compile
the document before typing anything in `tex/submission.tex`.
Run `make` form the root directory. Complete `make` documentation is
provided within the Makefile. To get started, clone the repository and try out
a simple `make` command:
```
$ make clean -s
```
If the command runs correctly, it will remove the assignment PDF from your root
directory. Don't worry though! Try recreating it again using the following
command:
```
$ make without_solutions -s
```
After some file shuffling and a few passes of the LaTeX compiler, you should see
a fresh new assignment handout in the root directory. Now try the following
command:
```
$ make with_solutions -s
```
You should now see a `\*_Solutions.pdf` file in your root directory. This
contains the content from the original handout as well as your solutions (those
typed into `tex/submission.tex`)! If you haven't edited `tex/submission.tex`
yet, it will probably look a lot like the `without_solutions` version.
To see what it looks like with some solution code, open up `tex/submission.tex`
and enter the following code between the tags `### START CODE HERE ###` and
`### END CODE HERE ###`:
```latex
\begin{answer}
% ### START CODE HERE ###
\LaTeX
% ### END CODE HERE ###
\end{answer}
```
Now run the following command:
```
$ make -s
```
This command re-runs the default `make` target, which is, conveniently,
`make with_solutions`. Opening the file `\*_Solutions.pdf`, you should see
something like the following:
## How to create a typeset submission using LaTeX on Overleaf
[Overleaf](https://www.overleaf.com/) is an online WYSIWYG editor. While we
recommend becoming familiar with compiling LaTeX locally, you may instead prefer
the ease of Overleaf. Follow these steps to get set up with Overleaf (after
creating an account for yourself):
1. Create a new "Blank Project".
2. Give the project a name.
3. Delete the file named "main.tex".
4. Upload the following files to your project:
- "submission.tex"
- "macros.tex"
5. Open the Overleaf menu at the top left.
6. Change the "Main document" to "submission.tex".
7. Recompile the document.
Good luck with the assignment! Remember that you can always submit organized
and legible handwritten PDFs instead of typeset documents.