|
| 1 | +# [The Binary Garden](https://rmscode.github.io/binary-garden/) |
| 2 | + |
| 3 | +This is my digital garden — a wiki where I share knowledge and the things that interest me, presented as an [online Zensical book](https://www.zensical.org/). |
| 4 | + |
| 5 | +*It is best experienced in the [web format](https://rmscode.github.io/binary-garden/), or you can [build it yourself](#building-and-serving-the-site).* |
| 6 | + |
| 7 | +## Contributing |
| 8 | + |
| 9 | +Contributions are welcome when errors or improvements are identified. Click the **edit** button at the top right of any page to propose changes via a pull request. Alternatively, you can open an [issue](https://github.com/rmscode/binary-garden/issues/new) for me to review. |
| 10 | + |
| 11 | +### Guidelines |
| 12 | + |
| 13 | +I follow [Angular's commit message guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines) and encourage you to do the same. |
| 14 | + |
| 15 | +``` |
| 16 | +{type_of_change}({file_changed}): {short_description} |
| 17 | +
|
| 18 | +{full_description} |
| 19 | +``` |
| 20 | + |
| 21 | +> **Note**: Omit the file extension. For example, if you are editing `README.md`, use `README` in the commit message. |
| 22 | +
|
| 23 | +#### Correcting existing content: |
| 24 | + |
| 25 | +``` |
| 26 | +fix(cats): removed inaccurate statement about cats having souls |
| 27 | +
|
| 28 | +Cats do not have souls. They are soulless, evil creatures. |
| 29 | +``` |
| 30 | + |
| 31 | +#### Correct grammar, spelling or broken links: |
| 32 | + |
| 33 | +``` |
| 34 | +style(dogs): fixed broken links to external dog wiki |
| 35 | +
|
| 36 | +An incorrect link was pasted in the dogs.md file multiple times. Fixed all occurrences. |
| 37 | +``` |
| 38 | + |
| 39 | +#### Improving existing content: |
| 40 | + |
| 41 | +``` |
| 42 | +perf(birds): added more supporting evidence for how birds are actually surveillance drones |
| 43 | +
|
| 44 | +Found and added totally legit examples from the r/BirdsArentReal subreddit. Trust me bro. |
| 45 | +``` |
| 46 | + |
| 47 | +#### Update the dependencies required to build the site (plugins, zensical config, etc). |
| 48 | + |
| 49 | +``` |
| 50 | +chore(zensical): update navigation tree |
| 51 | +``` |
| 52 | + |
| 53 | +## Building and serving the site |
| 54 | + |
| 55 | +> [!IMPORTANT] |
| 56 | +> You need to have Python and a Python package manager installed on your system before you install Zensical. It is recommended that you follow the [Python Setup and Usage](https://docs.python.org/3/using) instructions for your operating system provided on the [Python website](https://www.python.org/). Modern Python distributions include the pip package manager, so unless you are developing Python software and use `uv`, this is the simplest option to install Zensical on your system. |
| 57 | +
|
| 58 | +After cloning/forking the repo to your computer... |
| 59 | + |
| 60 | +1. Enter the repo's directory and create a Python virtual environment: |
| 61 | + - `python -m venv .venv` |
| 62 | +2. Activate the virtual environment: |
| 63 | + - Windows: `.\.venv\Scripts\Activate.ps1` |
| 64 | + - Linux or macOS: `source .venv/bin/activate` |
| 65 | +3. Install Zensical: `pip install zensical` |
| 66 | +4. Build a static site with `zensical build` or use `zensical serve` to run Zensical's built in web server. |
0 commit comments