https://github.com/mikmuellerdev/schoolnotes-cli
CLI for Schoolnotes / Tex
https://github.com/mikmuellerdev/schoolnotes-cli
Last synced: 4 months ago
JSON representation
CLI for Schoolnotes / Tex
- Host: GitHub
- URL: https://github.com/mikmuellerdev/schoolnotes-cli
- Owner: MikMuellerDev
- Created: 2021-11-22T16:35:00.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-20T12:24:25.000Z (over 4 years ago)
- Last Synced: 2025-02-24T12:18:33.589Z (over 1 year ago)
- Language: TeX
- Size: 3.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
```
___ _ _ _ _ _
/ __| __| |_ ___ ___| | \| |___| |_ ___ ___
\__ \/ _| ' \/ _ \/ _ \ | . / _ \ _/ -_|_--<
|___/\__|_||_\___/\___/_|_|\_\___/\__\___/__/
```
# Schoolnotes-Cli
Schoolnotes-Cli is a bash script which intents to make using $\LaTeX$ easier and more user-friendly.
### Features
| Feature | CLI command |
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| Creating a new notebook in the current directory | `-i or --init [template]` |
| Creating a new notebook with a custom name in a new directory | `-i or --init [name] [template]` optional: `-o or --open` to edit right away |
| Removing temporary files from the current directory | `-c or --clean` |
| Compiling the `main.tex` entry-point to a `.pdf` file | `-b or --build` |
| Watching for filechanges and compiling if they are any | `-w or --watch` |
| Viewing the `main.pdf` | `-v or --view` |
| Updating SchoolNotes to the current version | `-u or --update` |
| Editing in the current directory | `-e or --edit` |
| Automatically renaming `main.pdf` like the current notebook, including the author's name | `-r or --rename` |
| Editing in the `~/SchoolNotes` directory | `schoolnotes` (no arguments) |
### Templates
- **normal**, used in everyday life
- **math**, used for creating mathematical handouts
- **it**, used in computer class
- **complex**, used to create larger papers and complex assignments
### Dependencies
- A working lualatex configuration, like `texlive-full`
- `VSCode` for editing
- [Optional] `Okular` vor viewing
- `sed` (should be installed already)
- `curl / wget` (should be installed already)
## Installation
```
wget https://raw.githubusercontent.com/MikMuellerDev/schoolnotes-cli/main/install.sh && sudo bash install.sh i && rm install.sh
```
```
curl -fsSl https://raw.githubusercontent.com/MikMuellerDev/schoolnotes-cli/main/install.sh > install.sh && sudo bash install.sh i && rm install.sh
```
## Removal
```
wget https://raw.githubusercontent.com/MikMuellerDev/schoolnotes-cli/main/install.sh && sudo bash install.sh r && rm install.sh
```
```
curl -fsSl https://raw.githubusercontent.com/MikMuellerDev/schoolnotes-cli/main/install.sh > install.sh && sudo bash install.sh r && rm install.sh
```