From cd65ce204f4e2439d00ac48095f5a65f7308a8ee Mon Sep 17 00:00:00 2001 From: Henrique Alves Date: Mon, 8 May 2023 11:50:27 -0300 Subject: Update readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4865a29..59c81ff 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # GLAM - Godot Lightweight Addon Manager -✨GLAM✨ is a CLI tool to facilitate addon managing for Godot projects. It's lightweight and focused on providing basic addon managament such as installing, removing, and applying changes to any addon that can be installed via git. It does so by adding two files to your project: a **.glam** file that tracks each installed addon and their installed commit, and a **.glam.d/** folder that stores the addons repositories, so you can easily update or apply changes to them - after installing or updating an addon, it's files are copied to the Godot project `addons/` folder. The tool also provides a meaningful `help` for all commands. +✨GLAM✨ is a CLI tool to facilitate addon managing for Godot 4.0 projects. It's lightweight and focused on providing basic addon managament such as installing and applying changes to any addon that can be installed via git. It does so by adding two files to your project: a **.glam** file that tracks each addon repository and their installed commit, and a **.glam.d/** folder that stores the addons repositories, so you can easily update or apply changes to them - after installing or updating an addon, it's files are copied to the Godot project `addons/` folder. The tool also provides a meaningful `help` for all commands. This is **not** a one-size-fits-all kind of solution. I created it because I wanted an easy way to start a Godot project with addons I use often without having to download them via the Asset Manager, and to develop my own Addons while I use them on other projects (hence `glam apply`). If you are interested in other alternatives, check the **Alternatives** section. ## Installing -The project only works on UNIX (Linux/Mac) machines. You need `git` installed for the commands to work. +The project only works on UNIX (Linux/Mac) machines. You need `git` installed for the commands to work. It works on **Godot 4.0**, but it should work with any Godot project. **This is a WIP project**, so I'm not too focused on providing releases; right now, the easiest way to install this project is via `cargo install godot-glam` (https://lib.rs/crates/godot-glam). This may change if this project gain traction. @@ -14,9 +14,9 @@ You can initialize your project (with meaningful `.gitignore` and `.gdignore` fi glam init ``` -You can install new addons with: +You can add new addon repositories with: ``` -glam install-package https://github.com/henriquelalves/GodotTIE +glam add https://github.com/henriquelalves/GodotTIE ``` If you want to use ✨GLAM✨ with a CI/CD, you can `.gitignore` the `addons/` folder and install all addons listed in the `.glam` file with: @@ -34,7 +34,7 @@ glam apply GodotTIE ## TODO's -- [ ] Check if project is Godot 3 vs Godot 4 for initialization. +- [ ] Implement multiple addons per repository ## Alternatives - https://github.com/imjp94/gd-plug -- cgit v1.2.3