Skip to content

Commit

Permalink
Edited README.md for clarity
Browse files Browse the repository at this point in the history
attempting to address [this steam community post](https://steamcommunity.com/app/661130/eventcomments/7404569601243958277#c7404569601245180365) and reduce contributor anxiety
  • Loading branch information
loliwut authored Sep 16, 2024
1 parent 2af89b4 commit 56aff12
Showing 1 changed file with 12 additions and 8 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,6 @@ This repository contains the source files for the Alpha Blend Interactive Docume

## How to Contribute

### Install python, dependencies and mkdocs

1. Install [CPython](https://python.org)
1. `pip install -U poetry`
1. `cd path/to/docs`
1. `poetry install --no-root`
1. `mkdocs serve`

### Branches

- master is our production branch, means anything in master goes/is in the production site at [docs.abinteractive.net](https://docs.abinteractive.net/)
Expand All @@ -34,3 +26,15 @@ Release are made by ABI staff.

Additional notes:
For deploying to production merge develop into master, and grab the latest build artifact from teamcity after it has been built.

## Checking Your Work

This is completely optional and provided to check work as it will appear on the live site before making PRs.

### Install python, dependencies and mkdocs

1. Install [CPython](https://python.org)

This comment has been minimized.

Copy link
@kafeijao

kafeijao Sep 16, 2024

Contributor

Python*

This comment has been minimized.

Copy link
@LucHeart

LucHeart Sep 16, 2024

Member

lol thats from nexis, CPython isnt wrong tho

1. `pip install -U poetry`
1. `cd path/to/docs`
1. `poetry install --no-root`
1. `mkdocs serve`

0 comments on commit 56aff12

Please sign in to comment.