Skip to content
This repository has been archived by the owner on Dec 3, 2019. It is now read-only.

#36 rewrite README #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

#36 rewrite README #39

wants to merge 1 commit into from

Conversation

Createdd
Copy link
Member

updated README proposal.
馃殌 馃帀

@Createdd Createdd self-assigned this Feb 10, 2017
@Createdd Createdd requested a review from lumio February 10, 2017 22:47

On Macs with brew:
```
brew install mongodb
mongod --config /usr/local/etc/mongod.conf
```

## Install components and start server
## 鈿栵笍 License
[鈩癸笍 AGPL v3 鈩癸笍](http://www.gnu.org/licenses/agpl-3.0)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the license is unnessary since it is shown in the code view on the top right.
Additionally you added a badge as well... so this is redundant.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the "How to write README" guide they suggest to explicitly state the License. I have also seen it in a lot of other READMEs (additional to a badge and the official file). Do you want to keep the README as short as possible?

For feedback, questions or suggestions get in contact with

- <img src="https://avatars3.githubusercontent.com/u/914637?v=3&s=460" height="60"> [Benjamin](https://github.com/lumio)
- <img src="https://s3-us-west-2.amazonaws.com/s.cdpn.io/854371/profile/profile-80_2.jpg" height="60"> [Daniel](https://github.com/DDCreationStudios)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even though it looks good, this is an open source project and I think for the sake of OS, the developers shouldn't stand out that much.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think that's a problem? I have seen it many other times and especially when there are actually not many other contributers it can be good to establish a foundation. ;)

The core team has a progress schedule once a month.
---

<img src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDIwLjEuMCwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+CjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI+Cgkuc3Qwe29wYWNpdHk6NS4wMDAwMDBlLTAyO2ZpbGw6dXJsKCNTVkdJRF8xXyk7fQoJLnN0MXtmaWxsOiNGRkREMzM7fQoJLnN0MntmaWxsOiNGRkZGRkY7fQo8L3N0eWxlPgo8cmFkaWFsR3JhZGllbnQgaWQ9IlNWR0lEXzFfIiBjeD0iMjU1LjUyODYiIGN5PSI4Ni40MzM2IiByPSIyNDcuMDY4OCIgZ3JhZGllbnRUcmFuc2Zvcm09Im1hdHJpeCgwLjk5MTQgMC4xMzEyIC0zLjA3NzM2OGUtMDIgMC4yMzI2IDEwLjg5NTMgMzA0Ljk4OTUpIiBncmFkaWVudFVuaXRzPSJ1c2VyU3BhY2VPblVzZSI+Cgk8c3RvcCAgb2Zmc2V0PSIwIiBzdHlsZT0ic3RvcC1jb2xvcjojMDAwMDAwIi8+Cgk8c3RvcCAgb2Zmc2V0PSIxIiBzdHlsZT0ic3RvcC1jb2xvcjojMDAwMDAwO3N0b3Atb3BhY2l0eTowIi8+CjwvcmFkaWFsR3JhZGllbnQ+CjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik01MDYuNSwzOTFjLTQuMiwzMS43LTExNy4zLDQzLTI1Mi41LDI1LjFjLTEzNS4zLTE3LjktMjQxLjUtNTguMS0yMzcuMy04OS45czExNy4zLTQzLDI1Mi41LTI1LjEKCUM0MDQuNCwzMTksNTEwLjcsMzU5LjMsNTA2LjUsMzkxeiIvPgo8Zz4KCTxwYXRoIGNsYXNzPSJzdDEiIGQ9Ik04MS45LDE3MC4zYzQ3LjgtMjkuNiwxNjEuNy01MS4xLDIyNy45LTQwbDEyMS40LDEwMi40TDgxLjksMTcwLjN6Ii8+CjwvZz4KPGc+Cgk8cGF0aCBjbGFzcz0ic3QyIiBkPSJNODMsMzMyLjhWMTcyLjdsMzQ1LDYxLjd2NzQuM2MtMTMsMy41LTIxLjksMTUuMy0yMS45LDI4LjdjMCwxMy40LDguOSwyNS4yLDIxLjksMjguN3YyMi41TDgzLDMzMi44eiIvPgoJPHBhdGggY2xhc3M9InN0MSIgZD0iTTg1LDE3NS4xbDM0MSw2MXY3MS4xYy0xMyw0LjItMjEuOSwxNi40LTIxLjksMzAuMmMwLDEzLjgsOC45LDI2LDIxLjksMzAuMnYxOC43TDg1LDMzMS4xVjE3NS4xIE04MSwxNzAuMwoJCXYxNjQuM2wzNDksNTYuNHYtMjYuNGMtMTItMi43LTIxLjktMTMuOC0yMS45LTI3LjFjMC0xMy4zLDkuOS0yNC40LDIxLjktMjcuMXYtNzcuNkw4MSwxNzAuM0w4MSwxNzAuM3oiLz4KPC9nPgo8Zz4KCTxjaXJjbGUgY2xhc3M9InN0MSIgY3g9IjEzNSIgY3k9IjI0Ny44IiByPSIzMi40Ii8+CjwvZz4KPGc+Cgk8Y2lyY2xlIGNsYXNzPSJzdDEiIGN4PSIxOTQuNCIgY3k9IjMwMC43IiByPSIyMS40Ii8+CjwvZz4KPGc+Cgk8Y2lyY2xlIGNsYXNzPSJzdDEiIGN4PSIyNTYuNSIgY3k9IjI0Ny44IiByPSIyNS41Ii8+CjwvZz4KPHBhdGggY2xhc3M9InN0MSIgZD0iTTM3Mi45LDI3OC44Yy03LjctNy4xLTE5LjYtNi42LTI2LjcsMS4xYy0xLjQsMS41LTIuNCwzLjEtMy4zLDQuOWMtMC40LTAuNC0wLjgtMC44LTEuMi0xLjIKCWMtMTMuMS0xMi4xLTMzLjYtMTEuMi00NS42LDEuOWMtMTIuMSwxMy4xLTExLjIsMzMuNiwxLjksNDUuNmMxMy4xLDEyLjEsMzMuNiwxMS4yLDQ1LjYtMS45YzUuMS01LjYsNy45LTEyLjQsOC40LTE5LjQKCWM3LjMsMy40LDE2LjIsMS45LDIyLTQuM0MzODEuMSwyOTcuOCwzODAuNiwyODUuOCwzNzIuOSwyNzguOHoiLz4KPC9zdmc+Cg==" height="200" align="right">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't see that image being rendered. But let's leave it in and try if this works :)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants