Skip to content

Commit 8a59226

Browse files
docs: first pass at README updates
1 parent 9cbf903 commit 8a59226

File tree

1 file changed

+28
-21
lines changed

1 file changed

+28
-21
lines changed

README.md

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,36 @@
11
# laddr
22

3-
Laddr -- pronounced "ladder" and named after the essential tool for fire brigades -- is a web application designed to create an online home-base for [Code for America brigades](http://brigade.codeforamerica.org).
3+
Laddr -- pronounced "ladder" and named after the essential tool for fire brigades -- is an online homebase for your local [Code for America Brigade](http://brigade.codeforamerica.org). It is designed to be cheap-to-host and easy-to-hack platform for civic hacking groups to maintain an online precense and automate support for their real-world operations.
44

5-
## Hosting
6-
Code for Philly hosts and maintains instances for free for other brigades on our multi-tenant infrastructure. Make a post to the [Hosting Requests](http://forum.laddr.us/c/hosting-requests) category of Laddr's support forum to get started with a sandbox instance.
5+
## Getting started
76

8-
## Help / Support / Questions / Chat
9-
Guides and support are available at our Discourse foreum at [forum.laddr.us](http://forum.laddr.us/)
7+
There are three ways to get started with Laddr:
108

11-
Join Code for Philly's Slack channel for Laddr, you can self-register via codeforphilly.org: [codeforphilly.org/chat/laddr](https://codeforphilly.org/chat/laddr)
9+
- [Request free hosting of a copy for your brigade](http://forum.laddr.us/c/hosting-requests), courtesy of Code for Philly
10+
- [Clone laddr](#clone-laddr) to work on and contribute to its core, shared functionality
11+
- [Extend laddr](#extend-laddr) to create a workspace for customizing a copy of laddr for your brigade without forking the whole thing
12+
13+
### Clone Laddr
14+
15+
*TODO: document me*
16+
17+
### Extend Laddr
18+
19+
*TODO: document me*
20+
21+
## Support
22+
23+
- [Laddr forum/wiki](http://forum.laddr.us/)
24+
- [#laddr channel in Code for Philly's Slack](https://codeforphilly.org/chat/laddr)
25+
- #laddr channel in Code for America's Slack
26+
- [laddr issues on GitHub](https://github.com/CodeForPhilly/laddr/issues)
27+
28+
Guides and support are available at our Discourse forum at
29+
30+
Join Code for Philly's Slack channel for Laddr, you can self-register via codeforphilly.org:
1231

1332
## Features
33+
1434
- [Projects Directory]
1535
- Each project can have a users URL, developers URL, markdown README
1636
- Projects can be tagged by topic, tech, and event
@@ -39,7 +59,9 @@ Join Code for Philly's Slack channel for Laddr, you can self-register via codefo
3959
- Croatian and Korean translations in progress
4060

4161
## Brigades using Laddr
62+
4263
- [Code for Philly](http://codeforphilly.org)
64+
- [Extending repository](https://github.com/CodeForPhilly/codeforphilly.org)
4365
- [Code for Dayton](http://codefordayton.org)
4466
- [Code for Croatia](http://codeforcroatia.org)
4567
- [Creative Commons Korea](http://labs.cckorea.org/)
@@ -48,21 +70,6 @@ Join Code for Philly's Slack channel for Laddr, you can self-register via codefo
4870
- [Code for Raleigh](http://www.codeforraleigh.com/)
4971
- [Open Charlotte Brigade](https://brigade.opencharlotte.org/)
5072

51-
## Requirements
52-
Laddr is built on the Emergence PHP framework and deployement engine, and requires an Emergence server to host it.
53-
54-
Emergence takes just a few minutes to setup on a Linux VM, and is designed to have a fresh system to itself. Once launched
55-
it will configure services on the machine as-needed to host an instance of the application along with any other
56-
sites, clones, or child sites. The guides for Ubuntu and Gentoo are most up-to-date: http://emr.ge/docs/setup
57-
58-
## Installation via Emergence (linked child)
59-
- Create an emergence site that extends v2.laddr.us
60-
61-
## Installation from Git
62-
- Create an emergence site that extends skeleton.emr.ge (access key: 8U6kydil36bl3vlJ)
63-
- Upload contents of git repository using WebDAV client (CyberDuck is the best open-source option)
64-
65-
6673
[Projects Directory]: http://codeforphilly.org/projects
6774
[Projects list available via dynamic CSV]: http://codeforphilly.org/projects.csv
6875
[Members Directory]: http://codeforphilly.org/people

0 commit comments

Comments
 (0)