11# Madison
22
3- [ ![ Build Status] ( https://api.travis-ci.org/opengovfoundation/madison.svg?branch=master )] ( https://travis-ci.org/opengovfoundation/madison )
4- [ ![ Scrutinizer Code Quality] ( https://img.shields.io/scrutinizer/g/opengovfoundation/madison.svg )] ( https://scrutinizer-ci.com/g/opengovfoundation/madison?branch=master )
3+ [ ![ CircleCI] ( https://circleci.com/gh/opengovfoundation/madison/tree/master.svg?style=svg )] ( https://circleci.com/gh/opengovfoundation/madison/tree/master )
54
6- Madison is an open-source, collaborative document editing platform. While
5+ Madison is an open-source document engagement and feedback platform. While
76Madison can be used to collaborate on many different kinds of documents, the
8- official version is being built with legislative and policy documents in mind.
7+ official version is being built legislative and policy documents in mind.
98
109If you have questions about Madison, please open an issue and we will try to
1110respond as soon as possible.
@@ -14,55 +13,16 @@ Check out the [Madison Documentation](https://github.com/opengovfoundation/madis
1413or jump right into the [ Issue Log] ( https://github.com/opengovfoundation/madison/issues )
1514for more information on the project.
1615
17- We have created a new, public mailing list for Madison development in Google
18- Groups that you might be interested in subscribing to. We'll be using this as
19- the official channel for all Madison developer news, announcements, and chat
20- from now on. (Though bugs should still be reported here on Github.) You can sign
21- up for it here:
22-
23- [ Madison Mailing List] ( https://groups.google.com/forum/#!forum/madison-developers )
24-
25- We have also created a very short survey to find out more about the developers
26- using Madison. Please take a few minutes to fill out this survey so we can
27- better understand what your needs are and who is using Madison:
28-
29- [ Madison Developers Survey] ( http://goo.gl/forms/BV4Flc0zx7 )
30-
3116## Architecture
3217
3318As of 4.0, Madison is a generally plain Laravel (PHP) application.
3419
35- ## Installation
36-
37- Please take a look at the ` docs/INSTALL.md ` or ` docs/INSTALL.OSX.md ` files for
38- how to install Madison.
39-
40- ## Customization
41-
42- There are a few different mechanisms for customizing Madison to your liking.
43-
44- ### Language & i18n
45-
46- The majority of the language in the system is defined in the ` client/app/locales/ `
47- folder within relevant JSON files, defined for each supported language. If you
48- create a file that matches the necessary language name in
49- ` client/app/locales/custom/ ` this will overwrite what is set as default in the base
50- language files.
51-
52- ### Style
53-
54- Any stylesheets placed within the ` client/app/sass/custom/ ` folder will be processed
55- during the build and can overwrite any existing styles. You can also change sass
56- variables here. Reference the sass config files in ` client/app/sass/config/ ` to see
57- what variables can be changed.
58-
59- ## Test Suite
20+ ## User Guide
6021
61- To run the tests, you will need to make sure to have a database created called
62- ` madison_testing ` , then simply run ` make test ` .
22+ Visit our [ Engagement Guide ] ( https://mymadison.io/sponsors/guide )
23+ for information on using Madison to run engagement rounds .
6324
64- ## How to help
25+ ## How to Help
6526
66- * Open an issue, claim an issue, comment on an issue, or submit a pull request to resolve one
67- * Document Madison - wiki documentation, installation guide, or docblocks internally
68- * Clean up existing code - I'm sure we've taken shortcuts or added lazy code somewhere.
27+ Open an issue, claim an issue, comment on an issue, or submit a pull request to
28+ resolve one.
0 commit comments