metamaps--metamaps/README.md

63 lines
4.1 KiB
Markdown
Raw Normal View History

Metamaps
=======
[![Build Status](https://travis-ci.org/metamaps/metamaps.svg?branch=develop)](https://travis-ci.org/metamaps/metamaps)
2017-01-12 03:40:01 +00:00
[![Code Climate](https://codeclimate.com/github/metamaps/metamaps/badges/gpa.svg)](https://codeclimate.com/github/metamaps/metamaps)
2015-01-29 20:35:48 +00:00
## What is Metamaps?
Metamaps is a free and open-source technology for changemakers, innovators, educators and students. It enables individuals and communities to build and visualize their shared knowledge and unlock their collective intelligence.
You can find a version of this software running at [metamaps.cc][site-beta], where the technology is being tested in an open beta.
Metamaps is developed and maintained by a distributed, nomadic community comprised of technologists, artists and storytellers. You can get in touch by using whichever of these channels you prefer:
## How do I learn more?
2016-10-19 23:01:15 +00:00
- Contact: [team@metamaps.cc](mailto:team@metamaps.cc) or [@metamapps](https://twitter.com/metamapps) on Twitter
- User Documentation: [docs.metamaps.cc](https://docs.metamaps.cc)
- User Community: [hylo.com/c/metamaps](https://www.hylo.com/c/metamaps)
2017-01-16 01:23:18 +00:00
- To see what we're developing, or to weigh in on what you'd like to see developed, see our [Metamaps Feedback and Features](https://trello.com/b/uFOA6a2x/metamaps-feedback-feature-ideas-requests) board on trello
2017-01-14 06:35:48 +00:00
- To follow along with, or contribute,to our design process, see our [Metamaps Design](https://trello.com/b/8HlCikOX/metamaps-design) board on trello
- To follow along with, or contribute to, our development process, see our [Github Issues and Pull Requests](https://github.com/metamaps/metamaps/issues)
- Request an invite to the open beta [here](https://metamaps.cc/request)
2017-01-24 00:37:50 +00:00
<!-- markdown hack to split two lists -->
2017-01-14 06:35:48 +00:00
- To send us a personal message get in touch with us via email, Twitter, or Hylo
- If you would like to report a bug, please check the [issues][contributing-issues] section in our [contributing instructions][contributing].
- If you would like to get set up as a developer, that's great! Read on for help getting your development environment set up.
## Installation for local use or development of Metamaps
First off is getting the code downloaded to your computer. You can download a zip file from github, but if you've got `git` you can just run `git clone https://github.com/metamaps/metamaps` in your terminal.
There are instructions for setup on various platforms, with particular support for Mac and Ubuntu, which can be found here:
2017-07-26 00:19:17 +00:00
- [Mac Install Walkthrough][mac-installation]
- [Ubuntu Install Walkthrough][ubuntu-installation]
2017-07-26 16:21:16 +00:00
If you prefer to isolate your install in a virtual machine, you may find it simpler to setup using Vagrant:
2017-07-26 00:19:17 +00:00
- [Vagrant installation][vagrant-installation]
2015-01-23 03:56:36 +00:00
2017-07-26 16:21:16 +00:00
We don't promise support for Windows, but at one point we had it running and we've kept those docs available for reference
2017-07-26 00:19:17 +00:00
- [Outdated Windows Walkthrough][windows-installation]
## Licensing information
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or(at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
The license can be read [here][license].
2017-01-04 22:17:53 +00:00
Copyright (c) 2017 Connor Turland
[site-beta]: http://metamaps.cc
2016-04-13 02:16:54 +00:00
[license]: https://github.com/metamaps/metamaps/blob/develop/LICENSE
[contributing]: https://github.com/metamaps/metamaps/blob/develop/doc/CONTRIBUTING.md
[contributing-issues]: https://github.com/metamaps/metamaps/blob/develop/doc/CONTRIBUTING.md#reporting-bugs-and-other-issues
[mac-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/MacInstallation.md
[ubuntu-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/UbuntuInstallation.md
[vagrant-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/VagrantInstallation.md
2016-04-13 02:16:54 +00:00
[windows-installation]: https://github.com/metamaps/metamaps/blob/develop/doc/WindowsInstallation.md