Change file structures so that the interior modpol folder IS the portable modpol.
Added documentation of how to pre-define the modpath and the storage file.
This commit is contained in:
15
modpol/DOCS/GOVERNANCE.md
Normal file
15
modpol/DOCS/GOVERNANCE.md
Normal file
@@ -0,0 +1,15 @@
|
||||
One administrator, @ntnsndr, holds ultimate decision-making power over the project. This is a temporary arrangement while we build trust as a community and adopt a more inclusive structure.
|
||||
|
||||
* **Autocracy** The administrator holds ultimate decision-making power in the community.
|
||||
* **Executive** The administrator is responsible for implementing—or delegating implementation of—policies and other decisions.
|
||||
* **Lobbying** If participants are not happy with the administrator's leadership, they may voice their concerns or leave the community.
|
||||
* **Do-ocracy** Those who step forward to do a given task can decide how it should be done, in ongoing consultation with each other and the administrator.
|
||||
* **Membership** Participation is open to anyone who wants to contribute. The administrator can remove misbehaving participants at will for the sake of the common good.
|
||||
* **Code of Conduct** Participants are expected to abide by the Contributor Covenant (contributor-covenant.org).
|
||||
|
||||
---
|
||||
|
||||
Created by [Nathan Schneider](https://gitlab.com/medlabboulder/modpol)
|
||||
|
||||
[](https://communityrule.info)
|
||||
[Creative Commons BY-SA](https://creativecommons.org/licenses/by-sa/4.0/)
|
||||
35
modpol/DOCS/Predefinitions.txt
Normal file
35
modpol/DOCS/Predefinitions.txt
Normal file
@@ -0,0 +1,35 @@
|
||||
When calling modpol.lua from another file, one may wish to use
|
||||
different functions than those included by default.
|
||||
|
||||
So far, 2 definitions need to be made BEFORE calling modpol.lua, the rest can be overwritten
|
||||
after calling modpol.lua .
|
||||
|
||||
setup:
|
||||
----------------
|
||||
Define the global modpol table:
|
||||
modpol = {}
|
||||
|
||||
the following 2 items *may* be defined, if they are not, then defaults will be used:
|
||||
========================
|
||||
--------------------
|
||||
modpol.get_script_dir()
|
||||
--------------------
|
||||
type: function
|
||||
|
||||
defaults to: a function that can only work in linux
|
||||
|
||||
usage: must return the file path of the modpol directory. If modpol is in a
|
||||
larger directory, such as a mod filesystem, make sure that the path returned is the "base"
|
||||
modpol folder, i.e. the folder with all the original modpol files.
|
||||
========================
|
||||
--------------------
|
||||
modpol.storage_file_path
|
||||
--------------------
|
||||
type: string
|
||||
|
||||
defaults to: topdir .. "/storage/storage-local.lua",
|
||||
where topdir is the directory defined by modpol.storage_file_path
|
||||
|
||||
usage: if you wish to use another method of storage than that provided by default,
|
||||
then you can save a filepath to the storage script here.
|
||||
|
||||
Reference in New Issue
Block a user