Skip to content

README: Replace dev instructions with link to GitHub Wiki. #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dijksterhuis wants to merge 4 commits into
base: development
Choose a base branch
from
Open

README: Replace dev instructions with link to GitHub Wiki. #203

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
88e01f4
README: Replace dev instructions with link to GitHub Wiki.
dijksterhuis Mar 16, 2025
c744e08
Updated links to wiki (changed the wiki structure recently).
dijksterhuis Apr 22, 2025
5adc904
fix typo (repalce -> replace).
dijksterhuis Apr 22, 2025
b13beb7
Tidy up documentation tool text.
dijksterhuis Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 6 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,40 +22,18 @@ Report issues using the "Issues" section above. Please be sure to follow the tem

The gamemode is a self-contained mission file. Simply download the mission from Steam Workshop into your server's mpmissions folder, and select it from the in-game mission list.

## Creating Custom Mike Force Missions

## installation for development
Follow one of the 'Setup' instruction sets in the [GitHub Wiki](https://github.com/Savage-Game-Design/Mike-Force/wiki).

Clone repo to local location of your choice and then symlink the `vn_mf.cam_lao_nam` folder into your Arma 3 missions folder.
## Development

Something like this:
Follow the GitHub Desktop setup instructions in the [GitHub Wiki](https://github.com/Savage-Game-Design/Mike-Force/wiki/Custom-MF:-1a.-Setup-via-GitHub-Desktop)

```shell
C:\Users\USERNAME\Documents\Arma 3\missions
```

Windows symlinks are handled with the `mklink` command.

```shell
mklink /j "C:\Users\USERNAME\Documents\Arma 3\missions\vn_mf.cam_lao_nam" SGD_mikeforce\HAM\vn_mf.cam_lao_nam
```

**note** Use the standard windows commandline for this, bash on windows makes a mess of the paths.


The SGD_Paradigm folder is also required to by symlinked in to be the `vn_mf.cam_lao_nam\paradigm` folder.


```shell
mklink /j "C:\Users\USERNAME\Documents\Arma 3\missions\vn_mf.cam_lao_nam\paradigm" SGD_paradigm
```
If you prefer to use `git` on the command line you'll likely be able to work it out from the wiki above, just replace the GitHub Desktop steps with the relevant `git` commands.

## generated doc file

Started a simple documentation generator : <https://github.com/ryantownshend/sqf_tools>
A simple documentation generator : <https://github.com/ryantownshend/sqf_tools>

The file `mikeforce_api.html` is a super crude parse of the header comments from within the project.

This can be fleshed out as we go, but it does provide a single place to view all the function file headers.