forge/Vervis
1
0
Fork 0
Code Pull requests Activity

Write initial reasonable README based on FunBot

Browse source
This commit is contained in:
fr33domlover 2016-03-05 03:54:37 +00:00
parent 9afd341aca
commit 11ed2b8110
1 changed files with 43 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

51
README.md
View file

@ -1,12 +1,47 @@
See the .cabal file for more info and link to project website the version # Vervis
**Vervis** is a project hosting and management application, with a focus on
softare projects and decentralization. It's still in very early development. At
the time of writing, it is a minimal web application in which you can create
Git repositories and watch their commit logs.
Vervis is free software, and is committed to software freedom and to freedom in
general. It is released to the public domain using the CC0 Public Domain
Dedication. For the boring "legal" details, see the file `COPYING`. Please use
and reuse Vervis for a Good purpose, and share your work too in the same
spirit.
## Installation
See `INSTALL.md`. To be honest, I haven't written it yet. Just use `stack
install`, pray, and ask me if anything fails. Ah, actually before that you need
to create a PostgreSQL database, generate an SSH key and update the settings in
`config/settings.yml` as needed. I promise to write detailed instructions soon.
## Using
See the .cabal file for more info and link to project website and version
control. control.
The official download location is Hackage. The official download location is the Darcs repository:
This library is free software, and is committed to software freedom. It is <http://hub.darcs.net/fr33domlover/vervis>
released to the public domain using the CC0 Public Domain Dedication. For the
boring "legal" details see the file `COPYING`.
See the file `INSTALL` for hints on installation. The file `ChangeLog` explains Releases are made to Hackage, the Haskell package repository.
how to see the history log of the changes done in the code. `NEWS.md` provides See <http://hackage.haskell.org/package/vervis>.
a friendly overview of the changes for each release.
See the file `INSTALL.md` for a detailed usage and deployment guide. The file
`ChangeLog` explains how to see the history log of the changes done in the
code. `NEWS.md` provides a friendly overview of the changes for each release.
## Reporting Bugs and Suggesting Features
If you found a bug, or you have an idea, a feature request or a wishlist item,
open a ticket for it! Even if you're goint to implement something or try to
solve it.
<http://rel4tion.org/projects/vervis/tickets/>
If you're going to implement some feature or fix some bug you found,
**start by opening a ticket** so that other people will know which features are
being developed and who does what.