minor repo cleanup (firoorg#1254)

remove INSTALL.md, _config.yml and lgtm.yml
remove broken badges from readme
adapt contributing to firo
edit doc/README.md
remove not needed files in /doc

CONTRIBUTING.md

@@ -1,7 +1,6 @@
-Contributing to Bitcoin Core
-============================
+# Contributing to Firo
 
-The Bitcoin Core project operates an open contributor model where anyone is
+The Firo project operates an open contributor model where anyone is
 welcome to contribute towards development in the form of peer review, testing
 and patches. This document explains the practical process and guidelines for
 contributing.
@@ -15,8 +14,7 @@ merging pull requests as well as a "lead maintainer" who is responsible for the
 release cycle, overall merging, moderation and appointment of maintainers.
 
 
-Contributor Workflow
---------------------
+## Contributor Workflow
 
 The codebase is maintained using the "contributor workflow" where everyone
 without exception contributes patch proposals using "pull requests". This
@@ -57,12 +55,12 @@ the pull request affects. Valid areas as:
 
  - *Consensus* for changes to consensus critical code
  - *Docs* for changes to the documentation
- - *Qt* for changes to bitcoin-qt
+ - *Qt* for changes to firo-qt
  - *Mining* for changes to the mining code
  - *Net* or *P2P* for changes to the peer-to-peer network code
  - *RPC/REST/ZMQ* for changes to the RPC, REST or ZMQ APIs
  - *Scripts and tools* for changes to the scripts and tools
- - *Tests* for changes to the bitcoin unit tests or QA tests
+ - *Tests* for changes to the firo unit tests or QA tests
  - *Trivial* should **only** be used for PRs that do not change generated
  executable code. Notably, refactors (change of function arguments and code
  reorganization) and changes in behavior should **not** be marked as trivial.
@@ -94,8 +92,8 @@ At this stage one should expect comments and review from other contributors. You
 can add more commits to your pull request by committing them locally and pushing
 to your fork until you have satisfied all feedback.
 
-Squashing Commits
----------------------------
+## Squashing Commits
+
 If your pull request is accepted for merging, you may be asked by a maintainer
 to squash and or [rebase](https://git-scm.com/docs/git-rebase) your commits
 before it will be merged. The basic squashing workflow is shown below.
@@ -121,16 +119,15 @@ The length of time required for peer review is unpredictable and will vary from
 pull request to pull request.
 
 
-Pull Request Philosophy
------------------------
+## Pull Request Philosophy
 
 Patchsets should always be focused. For example, a pull request could add a
 feature, fix a bug, or refactor code; but not a mixture. Please also avoid super
 pull requests which attempt to do too much, are overly large, or overly complex
 as this makes review difficult.
 
 
-###Features
+## Features
 
 When adding a new feature, thought must be given to the long term technical debt
 and maintenance that feature may require after inclusion. Before proposing a new
@@ -139,7 +136,7 @@ maintain it (including bug fixing). If features get orphaned with no maintainer
 in the future, they may be removed by the Repository Maintainer.
 
 
-###Refactoring
+## Refactoring
 
 Refactoring is a necessary part of any software project's evolution. The
 following guidelines cover refactoring pull requests for the project.
@@ -154,14 +151,13 @@ Project maintainers aim for a quick turnaround on refactoring pull requests, so
 where possible keep them short, uncomplex and easy to verify.
 
 
-"Decision Making" Process
--------------------------
+## "Decision Making" Process
 
-The following applies to code changes to the Bitcoin Core project (and related
-projects such as libsecp256k1), and is not to be confused with overall Bitcoin
+The following applies to code changes to the Firo project (and related
+projects such as libsecp256k1), and is not to be confused with overall Firo
 Network Protocol consensus changes.
 
-Whether a pull request is merged into Bitcoin Core rests with the project merge
+Whether a pull request is merged into Firo rests with the project merge
 maintainers and ultimately the project lead.
 
 Maintainers will take into consideration if a patch is in line with the general
@@ -179,15 +175,15 @@ In general, all pull requests must:
  - where bugs are fixed, where possible, there should be unit tests
  demonstrating the bug and also proving the fix. This helps prevent regression.
 
-Patches that change Bitcoin consensus rules are considerably more involved than
+Patches that change Firo consensus rules are considerably more involved than
 normal because they affect the entire ecosystem and so must be preceded by
 extensive mailing list discussions and have a numbered BIP. While each case will
 be different, one should be prepared to expend more time and effort than for
 other kinds of patches because of increased peer review and consensus building
 requirements.
 
 
-###Peer Review
+## Peer Review
 
 Anyone may participate in peer review which is expressed by comments in the pull
 request. Typically reviewers will review the code for obvious errors, as well as
@@ -220,21 +216,19 @@ higher in terms of discussion and peer review requirements, keeping in mind that
 mistakes could be very costly to the wider community. This includes refactoring
 of consensus critical code.
 
-Where a patch set proposes to change the Bitcoin consensus, it must have been
+Where a patch set proposes to change the Firo consensus, it must have been
 discussed extensively on the mailing list and IRC, be accompanied by a widely
 discussed BIP and have a generally widely perceived technical consensus of being
 a worthwhile change based on the judgement of the maintainers.
 
 
-Release Policy
---------------
+## Release Policy
 
-The project leader is the release manager for each Bitcoin Core release.
+The project leader is the release manager for each Firo release.
 
-Copyright
----------
+## Copyright
 
 By contributing to this repository, you agree to license your work under the 
-MIT license unless specified otherwise in `contrib/debian/copyright` or at 
+MIT license unless specified otherwise in `COPYING` or at 
 the top of the file itself. Any work contributed where you are not the original 
 author must contain its license header with the original author(s) and source.

README.md

@@ -6,8 +6,6 @@
 [![GitHub commits-since-last-version](https://img.shields.io/github/commits-since/firoorg/firo/latest/master)](https://github.com/firoorg/firo/graphs/commit-activity)
 [![GitHub commits-per-month](https://img.shields.io/github/commit-activity/m/firoorg/firo)](https://github.com/firoorg/firo/graphs/code-frequency)
 [![GitHub last-commit](https://img.shields.io/github/last-commit/firoorg/firo)](https://github.com/firoorg/firo/commits/master)
-[![Total alerts](https://img.shields.io/lgtm/alerts/g/firoorg/firo.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/firoorg/firo/alerts/)
-[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/firoorg/firo.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/firoorg/firo/context:cpp)
 
 [Firo](https://firo.org) formerly known as Zcoin, is a privacy focused cryptocurrency that utilizes zero-knowledge proofs which allows users to destroy coins and then redeem them later for brand new ones with no transaction history.
 

doc/README.md

@@ -1,38 +1,13 @@
-Firo Core 0.14.11.x
-=====================
+# Firo Core
+*Note: some of the documents in this repository might still refer to Bitcoin*
 
-Setup
----------------------
-[Firo Core] (https://firo.org/get-firo/download/) is the original Firo client and it builds the backbone of the network. However, it downloads and stores the entire history of Firo transactions (which is currently several hundreds MBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
-
-Running
----------------------
-The following are some helpful notes on how to run Firo on your native platform.
-
-### Unix
-
-Unpack the files into a directory and run:
+## Setup
 
-- `bin/firo-qt` (GUI) or
-- `bin/firod` (headless)
-
-### Windows
-
-Unpack the files into a directory, and then run firo-qt.exe.
-
-### OS X
-
-Drag Firo-Core to your applications folder, and then run Firo-Core.
+[Firo Core] (https://firo.org/get-firo/download/) is the original Firo client and it builds the backbone of the network. However, it downloads and stores the entire history of Firo transactions (which is currently several hundreds MBs); depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.
 
-### Need Help?
 
-* See the documentation at the [Bitcoin Wiki](https://en.bitcoin.it/wiki/Main_Page)
-for help and more information.
-* Ask for help on [#bitcoin](http://webchat.freenode.net?channels=bitcoin) on Freenode. If you don't have an IRC client use [webchat here](http://webchat.freenode.net?channels=bitcoin).
-* Ask for help on the [BitcoinTalk](https://bitcointalk.org/) forums, in the [Technical Support board](https://bitcointalk.org/index.php?board=4.0).
+## Building
 
-Building
----------------------
 The following are developer notes on how to build Firo on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
 
 - [OS X Build Notes](build-osx.md)