Files
cmba-bylaws/README.md
Anthony Correa 688025aa44 2024 corrections, clarifications, and modifications
By-Laws and Rules updates for 2024 season.

Modification: Added affordances for using "last out" as a DR if there is no one on the bench (proposed via email, committeed 5/31/2024, voted in GroupMe chat 6/5/2024)
Correction: Correct "Uniform" section, addresses #11
Clarification: Reworded "no game" and "slaughter rule," addresses #9
Clarification: A llow president to postpone games for extraordinary circumstances, addresses #10

commit 6143d0fdd9
Author: Anthony Correa <a@correa.co>
Date:   Thu Jun 6 06:42:14 2024 -0500

    build

commit e34297f200
Author: Anthony Correa <a@correa.co>
Date:   Thu Jun 6 06:35:10 2024 -0500

    update publish date

commit ae31a90185
Author: Anthony Correa <a@correa.co>
Date:   Thu Jun 6 06:32:34 2024 -0500

    DR using last out

    Addresses #13

commit 89e0973c27
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 15:20:34 2024 -0600

    postponing games in extraordinary circumstances.

    address #10

commit 6d7d0531ce
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 15:19:29 2024 -0600

    removed "extraordinary circumstances", add "not resumed"

    this doesn't really apply, as the league does not resume suspended games in the regular season.

commit 2b29a561da
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 14:47:38 2024 -0600

    update readme with github pages instructions

commit 9a3939f42e
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 14:20:46 2024 -0600

    update metadata date

commit 063f66fc6b
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 13:41:57 2024 -0600

    clarify 'no game' and slaughter rule

    address issue #9

commit 8c91733d65
Author: Anthony Correa <a@correa.co>
Date:   Fri Jan 19 13:04:29 2024 -0600

    move uniform to correct section

    address issue #11
    remove "Uniform" from section "Team Rosters; Players and Eligibility; Uniforms"
    "Uniform" subsection stays in "Teams and Managers" section
    Add "Player Uniforms" reference to "Uniform" subsection in "General Play"
2024-06-06 06:57:56 -05:00

96 lines
3.7 KiB
Markdown

<p align="center">
<img src="https://github.com/anthonyscorrea/silver-memory/blob/a712bca2516c3e860f2c61ea383a3132ead0614b/cmba-logo.svg" width="200">
</p>
# CMBA Constitution and Bylaws
The Constitution and Bylaws for the baseball league known as the [Chicago Metropolitan Baseball Association (CMBA)](#about-the-cmba).
The compiled, published text can be found in the following formats:
- [PDF](build/cmba-bylaws.pdf)
- [HTML](build/cmba-bylaws.html)
- [ePUB](build/cmba-bylaws.epub)
The source text for this document can be found in Markdown format in [src/cmba-bylaws.md](src/cmba-bylaws.md).
## Building from source
### Requirements
Building from source requires:
- [Pandoc](https://pandoc.org)
- [GNU Make](https://www.gnu.org/software/make/)
### Steps
1. Download the latest release or clone the repo:
```
git clone https://github.com/anthonyscorrea/cmba-bylaws.git
```
2. Navigate to the root directory:
```
cd cmba-bylaws-master
```
3. Publish into desired format:
```
make {format}
```
were `{format}` is one of the below:
- All [default]: `make all` or `make`
- PDF: `make pdf`
- html: `make html`
- epub: `make epub`
5. Built files will be in the `build/` directory
## Markdown formatting
- `#` or `h1` is used for either "Constitution" or "Bylaws". They are not numbered, necessitating an `{.unnumbered}` class.
- Note: to get the numbering to match existing convention, a [Lua filter](https://github.com/jgm/pandoc/issues/5071#issuecomment-856918980) was required, see [jgm/pandoc#5701](https://github.com/jgm/pandoc/issues/5071)
- `##` or `h2` is used for sections
- `###` or `h3` is used for subsections
## Metadata
Metadata is stored in the `metadata.yml` file.
## Project history
The constitution and bylaws were modernized in 2021, using Google Docs. This project brings that effort into Git and Github. Previous commits show a generated plain-text history of the changes prior to this project (thanks to [gitdriver](https://github.com/larsks/gitdriver)), with the first being the version from 2016.
## Spell-checking
Spell-checking is performed on the pre-commit via [.spell-check/git-spell-check](.spell-check/git-spell-check) (courtesy of [mprpic/git-spell-check](https://github.com/mprpic/git-spell-check))
You can manually run spell-checking of all markdown files by running the script (requires [aspell](http://aspell.net)):
```console
./.spell-check/spell-check
```
Should you want to bypass the pre-commit hook (though not recommended), you can commit with
```console
git commit --no-verify".
```
## GitHub Pages
The html output can be hosted on GitHub Pages. Currently the site is hosted at the branch [gh-pages](https://github.com/anthonyscorrea/cmba-bylaws/tree/gh-pages). To update this page, you should:
1. First build from the main branch and build html
```console
git clone https://github.com/anthonyscorrea/cmba-bylaws.git
make html
```
2. Then clone the gh-pages branch and replace `index.html` with the updated page.
```console
git clone https://github.com/anthonyscorrea/cmba-bylaws.git --branch gh-pages cmba-bylaws-gh-pages
cp ../cmba-bylaws/build/cmba-bylaws.html ./cmba-bylaws-gh-pages/index.html
git push origin
```
## To-Do
- [X] Spell Checking
- [ ] Remove dependence on make, verify Windows support
## About the CMBA
This baseball league known as the [Chicago Metropolitan Baseball Association (CMBA)](http://cmbabaseball.com) has been formed for the purpose of providing the finest amateur baseball league in the State of Illinois and Midwest; a league where an up and coming young prospect for professional baseball may play and develop; where the talented veteran player can enjoy playing among the best competition; and bring friendship and sportsmanship to the Association.