https://github.com/georgejkaye/thesis
My thesis, 'A compositional theory of digital circuits'
https://github.com/georgejkaye/thesis
Last synced: 2 months ago
JSON representation
My thesis, 'A compositional theory of digital circuits'
- Host: GitHub
- URL: https://github.com/georgejkaye/thesis
- Owner: georgejkaye
- Created: 2023-03-03T14:16:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T21:47:39.000Z (8 months ago)
- Last Synced: 2025-04-12T06:43:13.957Z (2 months ago)
- Language: TeX
- Size: 1020 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# thesis
My thesis, 'A compositional theory of digital circuits'.
* **[Latest release](https://github.com/georgejkaye/thesis/releases/latest)**
## Entry points
* `main.tex`
## Compilation
First initialise the submodules:
```sh
git submodule update --init
```
Then compile with `make`:
```sh
# Generates a pdf
make
```
Or just `latexmk`:
```sh
latexmk -pdf main.tex
```
There are also `make` targets for clearing up the workspace.
```sh
# Remove auxiliary files
make tidy
# Remove auxiliary files and generated pdf
make clean
```
## Submodules
This project uses *submodules* to share diagrams and things between repos.
This means that the repo contains pointers to commits in other repos.
### Initialising
When you first clone the repo, run:
```sh
git submodule update --init
```
If you get a `Permission denied (publickey)` error, it's most likely because you don't have SSH set up on GitHub.
[Adding an SSH key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) should fix the issue.
### Reading
After updating, the submodules are in 'detached head' state, pointing at a certain commit.
If you're not making any changes, you don't have to do anything!
However, you may want to pull the latest changes from the submodule's remote.
To do this, switch to the `main` branch first.
```sh
cd example
git switch main
git pull
```
### Writing
If you want to make some changes to the submodule, make sure to switch to `main` (or another branch of your choice) first.
Then make the changes as usual, commit them in the submodule, push, and then add the directory in the parent repo to point it to the correct commit.
```sh
# checkout the submodule to the head
cd example
git switch main
echo "hello!" > hello.txt
# Push the changes to the submodule repo
git add hello.txt
git commit -m "Add hello.txt"
git push
# Now make the changes in the parent repo
cd ..
git add example
git commit -m "Update submodule"
git push
```
### Updating
By default, when doing a `git pull` after someone has changed the commit a submodule points to on the remote, this is not updated in the local version.
To fix this, run the following after doing a `git pull`:
```sh
git submodule update
```
Alternatively, you can set this to occur automatically after a `git pull` with the following option:
```sh
git config --global submodule.recurse true
```
## GitHub actions
Whenever you push to `main`, a pdf will be created, as well as zips containing all the assets used.