Documentation updates

[ArtFlag]

Hi and thanks a lot for this project!

I'm new to composer, so I might be asking basic questions but I suppose this could end up helping update the docs (I'm very happy to open a PR myself if this helps).

I've done the following:

1. Install composer via homebrew (on Mac)

2. Install nitro-porter

3. Ran

   composer global require "linc/nitro-porter"
   composer global install
   

   Also ran the global install from the nitro-porter directory, which installed more packages. Don't know if that's intended, but if so this should be in the docs?

4. Duplicated the config-sample.php file to the same folder (is that intended?) + filled my values.

5. Ran porter from a test folder, and also from the nitro-porter folder, and I'm always getting:

   Missing required parameter: source
   Missing required parameter: package
   Missing required parameter: output
   

Whatever option I use, I get the same message (porter list etc).

What should I do? Thanks!

[linc]

Hi @ArtFlag, thanks for checking out the project.

Try this command: cat ~/.composer/composer.json

In the output, look for "linc/nitro-porter": and tell me if it says "dev-main" or something else.

If it doesn't, try composer global require linc/nitro-porter:dev-main and then do composer global update and then the porter list command again.

If that works, it's that it installed the latest stable version and I have neglected to do a stable release to reflect the latest docs. 😅

[ArtFlag]

Hi and thank you for the reply!

I've decided to go on and do a clean move to Flarum vs migrating my data, but I hope your answer gets to help someone else 👍