Add README.md

README.md

@@ -0,0 +1,25 @@
+# Mapm. Max's Package Manager.
+
+### What is Mapm?
+
+Mapm is a package manager (written in Kotlin) for, you know, managing packages. So far it's VERY early in development, and does not have ANY WAY OF VERIFYING ANYTHING (at the moment.) Mapm is designed to run on the JVM, while using a UNIX-like system.
+
+### Why?
+
+No reason. :)
+
+### Setup
+
+First, make sure you have the JVM installed. I've been testing on Java 17 however I don't see why it won't work on later or earlier versions. Next, download the .jar to a place where it won't get deleted, and create an alias in your shell for mapm (or whatever you want to call it) which calls the JVM to run it (eg `alias mapm "java -jar /usr/local/bin/mapm"`). Then, create `/usr/mapm` and add it to the path. This is where mapm will download things to. Finally, test it all out by running `sudo mapm`. Type `grab`, press enter and type `mash`. This should download mash (my shell), make it executable, and save it to `/usr/mapm`.
+
+### 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
+
+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. For now, you'll have to contain it in a single binary, and you can't check for dependencies, but soon Mapm will automatically extract all the files you need soon.
+
+### Making your own repo
+
+For now, this isn't a thing, but you'll be able to when configuration is a thing.