diff --git a/README.md b/README.md index 8eaf847..6fe3576 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ No reason. :) ### Setup -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) +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) ### Usage @@ -18,7 +18,14 @@ Run mapm. For now, command line arguments aren't supported, but this is planned ### 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. +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 +``` +Zip all that up into a .tar.xz file, upload it to your server and add the link to your pull request. ### Making your own repo