From a1535c415752e0aac1e16bcf089aa1be97353119 Mon Sep 17 00:00:00 2001
From: Roman Tsypuk <rtsypuk@lohika.com>
Date: Sat, 16 Dec 2017 11:12:59 +0200
Subject: [PATCH] updated README, gitignore, moved styles

---
 .gitignore                                    |  1 -
 README.md                                     | 44 +++++++++++++++++++
 images/.directory                             |  4 --
 .../main/resources}/FilterView.css            |  6 +--
 4 files changed, 47 insertions(+), 8 deletions(-)
 delete mode 100644 images/.directory
 rename {bin/dsp/filter/design => src/main/resources}/FilterView.css (79%)

diff --git a/.gitignore b/.gitignore
index d48deabf..6633be8c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,7 +2,6 @@
 .idea/
 /classes*
 /product*
-/bin*
 out/
 .directory
 .settings
diff --git a/README.md b/README.md
index f8a2fa96..14aa161f 100644
--- a/README.md
+++ b/README.md
@@ -8,3 +8,47 @@ A cross-platform java application for decoding, monitoring, recording and stream
 
 ![sdrtrunk Application Overview - Version 0.3.0](https://github.com/DSheirer/sdrtrunk/wiki/images/ApplicationOverview_V0.3.0.png)
 **Figure 1:** sdrtrunk **Version 0.3.0** Application Screenshot
+
+# Instructions:
+## Build the project
+Project uses gradle as build system. You can build it with locally installed gradle or if you do not have/want install gradle you can use preconfigured linux/windows wrapper.
+### Build with locally installed gradle 4.3.1
+```
+gradle clean buildSdr
+```
+### Build with preconfigured wrapper for linux/windows
+Linux
+```
+./gradlew clean buildSdr
+```
+Windows
+```
+gradle.bat clean buildSdr
+```
+This would add gradle, download all project dependencied and build JAR
+
+## Development
+All dependencies/versions are controlled from build.gradle.
+To change the new release version tag of artifact - change property:
+```
+version = '0.3.1'
+```
+
+## Run SDRTrunk
+SDRTrunk is packed into single uber-jar file. There is need to have folders with dependecies and
+adding them with classpath. Just run with java.
+### Use Java8
+```
+java -jar build/libs/sdr-trunk-all-0.3.1.jar 
+```
+
+## TODO ITEMS
+
+- [x] Move project to gradle build
+- [x] Changed folders structure, based on java project
+- [x] Dependencies are moved to gradle and versions are updated
+- [x] Create uberJAR with all dependencies
+- [ ] Some dependencies left in imports folder. Find them and include into gradle
+- [ ] Move images into resources of project
+- [ ] Add tests to project. This would guarantee that after refactoring part of functionality is not broken
+- [ ] Create modular OOP system (radio-module, gui, web-ui, etc). This would allow to use RADIO modules to call from CLI, GUI or Web UI. And use SDRTrunk as dependency for other projects.
\ No newline at end of file
diff --git a/images/.directory b/images/.directory
deleted file mode 100644
index 4d114620..00000000
--- a/images/.directory
+++ /dev/null
@@ -1,4 +0,0 @@
-[Dolphin]
-PreviewsShown=true
-Timestamp=2013,9,20,8,54,21
-Version=3
diff --git a/bin/dsp/filter/design/FilterView.css b/src/main/resources/FilterView.css
similarity index 79%
rename from bin/dsp/filter/design/FilterView.css
rename to src/main/resources/FilterView.css
index 9c70eec8..eed6bc12 100644
--- a/bin/dsp/filter/design/FilterView.css
+++ b/src/main/resources/FilterView.css
@@ -1,12 +1,12 @@
 /* ....Show License.... */
 .chart {
-    -fx-background-image: url("../../../../images/Curve-fitted-background.png");
+    -fx-background-image: url("../../../images/Curve-fitted-background.png");
     -fx-padding: 15 25 15 15;
 }
 .chart-plot-background {
     -fx-background-color: red;
-    -fx-background-image: url("../../../../images/Curve-fitted-chart-background.png"), 
-                url("../../../../images/Curve-fitted-graph-gridlines.png");
+    -fx-background-image: url("../../../images/Curve-fitted-chart-background.png"),
+                url("../../../images/Curve-fitted-graph-gridlines.png");
     -fx-background-size: cover, auto;
     -fx-background-repeat: no-repeat, repeat;
     -fx-background-position: 0% 0%, 0% 100%;