mapm/README.md

32 lines
1.8 KiB
Markdown
Raw Normal View History

2024-08-28 14:17:52 +10:00
# Mapm. Max's Package Manager.
### What is Mapm?
2024-09-09 09:17:25 +10:00
Mapm is a package manager (written in Kotlin) for, you know, managing packages. So far it's VERY early in development. Mapm is designed to run on the JVM, while using a UNIX-like system.
2024-08-28 14:17:52 +10:00
### Why?
No reason. :)
### Setup
2024-09-09 09:00:03 +10:00
Make directories /usr/mapm and /usr/mapm/tmp. Add /usr/mapm to path. Download the files and make sure Gradle is installed. Run `gradle distTar` to compile a Tar file with all the needed Jars in it, including mapm. Untar the archive in build/distributions. Run `./(where tar extracted to)/bin/mapm`. (or mapm.bat if you're crazy)
2024-08-28 14:17:52 +10:00
### Usage
Run mapm. For now, command line arguments aren't supported, but this is planned for a later date. Once you're in mapm, you can type `grab` and press enter. Type the thing you want and it will download.
### Making a mapm package
2024-09-09 09:00:03 +10:00
To make a mapm package, go to https://git.maxwellj.xyz/mapm/stable and submit a pull request. Add your package's name as the file name, and the link to where your package is stored as the contents. Don't add anything more or you'll confuse mapm. Make sure the link points to a .tar.xz archive. The file structure should be like this:
```
├── (packagename) (A symbolic link to your executable in packagename.d)
└── (packagename).d
├── executable
└── Any other files your package needs
```
2024-09-09 09:19:04 +10:00
Zip all that up into a .tar.xz file, upload it to your server and add the link to your pull request. After creating the .tar.xz, use Mapm to create a checksum for the file. Run mapm, type `checksum`, press enter and type the file path. Press enter and copy the checksum to `(packagename).hash` inside your pull request.
2024-08-28 14:17:52 +10:00
### Making your own repo
For now, this isn't a thing, but you'll be able to when configuration is a thing.