Skip to content

Commit

Permalink
docs(readme) + mv: remade readme (base) + move list.rs to tree.rs
Browse files Browse the repository at this point in the history
  • Loading branch information
Thumuss committed Apr 2, 2024
1 parent e4c02a0 commit 689fc4f
Show file tree
Hide file tree
Showing 23 changed files with 445 additions and 153 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
.utpm
.vscode
utpm

/archives
57 changes: 32 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,52 @@
# Unofficial Typst Package Manager
<div align="center">

> Alias "utpm"
![UTPM logo](./logo.svg)

# What is that?
> _Unofficial typst package manager_
UTPM is a package manager for [local](https://github.com/typst/packages#local-packages) and remote packages.
The goal is to manage packages to use the new feature of typst, [importing other packages from different folders](https://typst.app/docs/reference/scripting/#packages)
**UTPM** is a _package manager_ for **[local](https://github.com/typst/packages#local-packages)** and **remote** packages. Create quickly new _projects_ and _templates_ from a **singular tool**, and then **publish** it _directly_ to **Typst**!

# How to use it?
</div>

You need two things, first create an `typst.toml` file by using `utpm create`:
## 🔥 Features

```bash
$ utpm create
```
- [x] ✨ Create packages automatically (`utpm create`)
- [x] ⏯️ Interactive
- [x] ⌨️ Cli version
- [x] 🛠 Put your package directly into your local packages (`utpm link`)
- 💻 Link without copying! (`utpm link --no-copy`)
- [x] 🌐 Dependencies outsite typst!
- [x] 📦 Install directly from the tool
- [x] 🔒 Portable installer (limited for now)
- [x] 📃 List all your packages
- [x] 🗃️ In a form of a list `utpm list`
- [ ] 🌲 In a form of a tree `utpm tree`
- [x] 💥 Customize your output (json or classic, `-j` in yours commands)
- [x] 🗄️ Delete and bulk delete your packages (`utpm unlink`, `utpm bulk-delete`)
- [ ] 🚀 Publish it directly to Typst!

Modify this file to match your project and finally, you need to copy the directory to the "special" directory by using `utpm link`:
***And others!***

## 🔎 How to use it?

### The basic workflow

```bash
$ utpm link
```

# Install

*Firstly you'll need*


## ⚡ Install

You will need Cargo and Rust.

Simpliest way :

```bash
git clone https://github.com/Thumuss/utpm.git &&
cd utpm &&
cargo install --path .
cargo install --git https://github.com/Thumuss/utpm
```

There is a `build.sh` to install/update the project.

# TODO:

See TODO.md

# Contribution
## Contribution

If you want to help me dev this package, simply make an issue or a PR

Expand Down
4 changes: 3 additions & 1 deletion TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,12 @@ The main focus will be :
- [ ] Implementation
- [ ] Compatibility with older version of typst
- [ ] Fix current bugs
- [ ] Use `tracing-subscriber` as a logger (thanks @frozolotl)
- [ ] Improve `README`: add more example, an explanation, ... (thanks @Pachi)
- [ ] Add `utpm publish` command, like [this repository](https://github.com/tingerrr/alabaster) (thanks @tingerrr)

If we got time, I'll add theses things:
- [ ] Docker, Compose and Kubernetes files (and examples)
- [ ] `Context`, it will change the actual structure of handling json and errors.
- [ ] ENV compatible.
- [ ] get along with `typst init`
- [ ] tree and list for `list` commands
Expand Down
7 changes: 0 additions & 7 deletions build.sh

This file was deleted.

224 changes: 224 additions & 0 deletions logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 689fc4f

Please sign in to comment.